docs: rewrite docs use docusaurus (#853)

eosphoros-ai · Nov 27, 2023 · 20aac63 · 20aac63
1 parent cd528b3
commit 20aac63
Show file tree

Hide file tree

Showing 247 changed files with 27,195 additions and 14,877 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,25 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.idea
+/bk
+
+.history
diff --git a/docs/Dockerfile b/docs/Dockerfile
@@ -0,0 +1,12 @@
+FROM node:lts
+
+WORKDIR /app
+COPY . /app
+
+RUN yarn install
+
+RUN npm run build
+
+EXPOSE 3000
+
+CMD ["npm", "run", "serve"]
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,25 @@
+# DB-GPT Website
+
+## Quick Start
+
+### Install dependencies 
+- Clone current project firstly!
+- Install docusaurus dependencies, generate node_modules folder.
+
+```
+sudo yarn install
+```
+
+### launch
+``` 
+yarn start
+```
+
+The default service starts on port `3000`, visit `localhost:3000`
+
+## Docker development 
+
+```commandline
+docker build -t dbgptweb .
+docker run --restart=unless-stopped -d -p 3000:3000 dbgptweb
+```