diff --git a/website/.gitignore b/website/.gitignore index d4fc4a5..b2d6de3 100644 --- a/website/.gitignore +++ b/website/.gitignore @@ -18,5 +18,3 @@ npm-debug.log* yarn-debug.log* yarn-error.log* - -test/Caddyfile \ No newline at end of file diff --git a/website/Dockerfile b/website/Dockerfile index 8cbfee5..ff49de7 100644 --- a/website/Dockerfile +++ b/website/Dockerfile @@ -4,4 +4,4 @@ COPY . /app WORKDIR /app RUN npm ci RUN npm run build -CMD npm run serve -- --port 80 --host 0.0.0.0 \ No newline at end of file +CMD npm run serve -- --port 80 --host 0.0.0.0 diff --git a/website/README.md b/website/README.md index f8a1c0a..aaba2fa 100644 --- a/website/README.md +++ b/website/README.md @@ -1,30 +1,41 @@ -# 雷池社区官网 +# Website -使用 [Docusaurus 2](https://docusaurus.io/) 开发。包含两部分内容:页面和文档。 +This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. -- 页面,在 src 目录下,手写 js -- 文档,在 docs 目录下,手写 markdown - -### 开发 - -```sh -# 开发 -npm start -# 支持 搜索功能的预览 -npm run serve -- --build --host 0.0.0.0 -``` - -接口代理 - -```sh -# 格式化配置文件 -caddy fmt test/Caddyfile --overwrite -# 启动服务 -caddy run --config test/Caddyfile -``` - -### 部署 +### Installation ``` -docker build -t website . +$ yarn ``` + +### Local Development + +``` +$ yarn start +``` + +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. + +### Build + +``` +$ yarn build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. + +### Deployment + +Using SSH: + +``` +$ USE_SSH=true yarn deploy +``` + +Not using SSH: + +``` +$ GIT_USER= yarn deploy +``` + +If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. diff --git a/website/blog/2023-08-04-website.md b/website/blog/2023-08-04-website.md new file mode 100644 index 0000000..7565093 --- /dev/null +++ b/website/blog/2023-08-04-website.md @@ -0,0 +1,3 @@ +# Website + +为了支持文档检索,采用 https://docusaurus.io/ 作为新的网站框架。 \ No newline at end of file diff --git a/website/docs/02-上手指南/01-guide_install.md b/website/docs/02-上手指南/01-guide_install.md index 73967cd..3c61f1c 100644 --- a/website/docs/02-上手指南/01-guide_install.md +++ b/website/docs/02-上手指南/01-guide_install.md @@ -1,7 +1,5 @@ --- title: "安装雷池" -group: "上手指南" -order: 2 --- # 安装雷池 diff --git a/website/docs/02-上手指南/02-guide_login.md b/website/docs/02-上手指南/02-guide_login.md index 50de32d..6837bae 100644 --- a/website/docs/02-上手指南/02-guide_login.md +++ b/website/docs/02-上手指南/02-guide_login.md @@ -1,7 +1,5 @@ --- title: "登录雷池" -group: "上手指南" -order: 3 --- # 登录雷池 diff --git a/website/docs/02-上手指南/03-guide_config.md b/website/docs/02-上手指南/03-guide_config.md index e714701..2710a0c 100644 --- a/website/docs/02-上手指南/03-guide_config.md +++ b/website/docs/02-上手指南/03-guide_config.md @@ -1,7 +1,5 @@ --- title: "配置防护站点" -group: "上手指南" -order: 4 --- # 配置防护站点 diff --git a/website/docs/02-上手指南/04-guide_test.md b/website/docs/02-上手指南/04-guide_test.md index d6a889b..f79fa0f 100644 --- a/website/docs/02-上手指南/04-guide_test.md +++ b/website/docs/02-上手指南/04-guide_test.md @@ -1,7 +1,5 @@ --- title: "测试防护效果" -group: "上手指南" -order: 5 --- # 测试防护效果 diff --git a/website/docs/02-上手指南/05-guide_upgrade.md b/website/docs/02-上手指南/05-guide_upgrade.md index 5e904ff..2f5a1f0 100644 --- a/website/docs/02-上手指南/05-guide_upgrade.md +++ b/website/docs/02-上手指南/05-guide_upgrade.md @@ -1,7 +1,5 @@ --- title: "升级雷池" -group: "上手指南" -order: 6 --- # 升级雷池 diff --git a/website/docs/02-上手指南/_category_.json b/website/docs/02-上手指南/_category_.json new file mode 100644 index 0000000..8929155 --- /dev/null +++ b/website/docs/02-上手指南/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "上手指南", + "link": { + "type": "generated-index" + } +} \ No newline at end of file diff --git a/website/docs/03-关于雷池/01-about_syntaxanalysis.md b/website/docs/03-关于雷池/01-about_syntaxanalysis.md index 644f7b2..4e24468 100644 --- a/website/docs/03-关于雷池/01-about_syntaxanalysis.md +++ b/website/docs/03-关于雷池/01-about_syntaxanalysis.md @@ -1,7 +1,5 @@ --- title: "智能语义分析技术" -group: "关于雷池" -order: 2 --- # 智能语义分析技术 diff --git a/website/docs/03-关于雷池/02-about_challenge.md b/website/docs/03-关于雷池/02-about_challenge.md index ea59ab2..1bdb8d8 100644 --- a/website/docs/03-关于雷池/02-about_challenge.md +++ b/website/docs/03-关于雷池/02-about_challenge.md @@ -1,9 +1,5 @@ --- title: "人机验证" -group: - title: "关于雷池" - order: 3 -order: 3 --- # 人机验证 diff --git a/website/docs/03-关于雷池/03-about_chaitin.md b/website/docs/03-关于雷池/03-about_chaitin.md index 3b30a47..3cc1bd3 100644 --- a/website/docs/03-关于雷池/03-about_chaitin.md +++ b/website/docs/03-关于雷池/03-about_chaitin.md @@ -1,7 +1,5 @@ --- title: "关于我们" -group: "关于雷池" -order: 9 --- # 关于我们 diff --git a/website/docs/03-关于雷池/04-about_changelog.md b/website/docs/03-关于雷池/04-about_changelog.md index 4d5487f..4cd5338 100644 --- a/website/docs/03-关于雷池/04-about_changelog.md +++ b/website/docs/03-关于雷池/04-about_changelog.md @@ -1,7 +1,5 @@ --- title: "版本更新记录" -group: "关于雷池" -order: 3 --- # 版本更新记录 diff --git a/website/docs/03-关于雷池/_category_.json b/website/docs/03-关于雷池/_category_.json new file mode 100644 index 0000000..f630626 --- /dev/null +++ b/website/docs/03-关于雷池/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "关于雷池", + "link": { + "type": "generated-index" + } +} \ No newline at end of file diff --git a/website/docs/04-常见问题排查/01-faq_install.md b/website/docs/04-常见问题排查/01-faq_install.md index 7a52378..4ddd2b4 100644 --- a/website/docs/04-常见问题排查/01-faq_install.md +++ b/website/docs/04-常见问题排查/01-faq_install.md @@ -1,9 +1,5 @@ --- title: "安装问题" -group: - title: "常见问题排查" - order: 2 -order: 1 --- # 安装问题 diff --git a/website/docs/04-常见问题排查/02-faq_login.md b/website/docs/04-常见问题排查/02-faq_login.md index a385377..1aa6e6d 100644 --- a/website/docs/04-常见问题排查/02-faq_login.md +++ b/website/docs/04-常见问题排查/02-faq_login.md @@ -1,7 +1,5 @@ --- title: "登录问题" -group: "常见问题排查" -order: 2 --- # 登录问题 diff --git a/website/docs/04-常见问题排查/03-faq_access.md b/website/docs/04-常见问题排查/03-faq_access.md index b26e48d..6370abd 100644 --- a/website/docs/04-常见问题排查/03-faq_access.md +++ b/website/docs/04-常见问题排查/03-faq_access.md @@ -1,7 +1,5 @@ --- title: "网站无法访问" -group: "常见问题排查" -order: 3 --- # 网站无法访问 diff --git a/website/docs/04-常见问题排查/04-faq_config.md b/website/docs/04-常见问题排查/04-faq_config.md index 9275e76..3cdf34d 100644 --- a/website/docs/04-常见问题排查/04-faq_config.md +++ b/website/docs/04-常见问题排查/04-faq_config.md @@ -1,7 +1,5 @@ --- title: "配置问题" -group: "常见问题排查" -order: 10 --- # 配置问题 diff --git a/website/docs/04-常见问题排查/05-faq_other.md b/website/docs/04-常见问题排查/05-faq_other.md index bdc33ca..b19879b 100644 --- a/website/docs/04-常见问题排查/05-faq_other.md +++ b/website/docs/04-常见问题排查/05-faq_other.md @@ -1,7 +1,5 @@ --- title: "其他问题" -group: "常见问题排查" -order: 10 --- # 其他问题 diff --git a/website/docs/04-常见问题排查/_category_.json b/website/docs/04-常见问题排查/_category_.json new file mode 100644 index 0000000..e331c6f --- /dev/null +++ b/website/docs/04-常见问题排查/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "常见问题排查", + "link": { + "type": "generated-index" + } +} \ No newline at end of file diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 7e1026e..308038b 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -9,9 +9,8 @@ const cnzz = `