soaped/dinky-website

Dinky Website

该项目保留了用于构建 Dinky 官方网站的所有资源，服务于 http://www.dlink.top/

条件

Dinky 网站基于 Docusaurus 。如果您的 Docusaurus 版本低于 2.0.0，请升级到 2.0.0。另请确保您的Node版本为 14.x。

安装

$ yarn / npm i

本地启动

$ yarn start /  npx docusaurus start [--port 3111 ] [--host localhost ] 默认端口为 3000

此命令启动本地开发服务器并打开浏览器窗口。大多数更改都会实时预览，而无需重新启动服务器。

编译

$ yarn build / npm run build

此命令将静态内容生成到 build 目录中，并且可以使用任何静态内容托管服务提供服务。

如何提交一个 PR

确保您有提交问题以跟踪 PR：https://github.com/DataLinkDC/dinky-website/issues

不要使用 git add . 提交所有更改；
只需推送您更改的文件，例如：
- *.md
- config.js
提交 PR 到 dev 分支；

添加新文档

为文档添加新文章

在 docs 下添加新的 .md 文件
在本地运行 server 验证文章是否正确显示
发送拉取的请求包含 *.md

为文档添加新版本

修改 docs 中的文档，然后在本地运行 yarn start或者 npx docusaurus start
将新添加的文档从 docs 复制到 versioned_docs 的新版本
修改最后一个所有版本在 /src/pages/version/index.js

文档目录结构

blog --博客分享 
docs --最新文档
download --下载
src --源码
  - components --组件
      - HomepageFeature --首页特性
  - css --css
  - pages  -- all version 页面管理 
     - versions --版本管理   
static --静态文件
  - img --官网图片
versioned_docs --历史版本文档
  - version-0.6.0 --版本0.6.0文档
  - version-0.6.1 --版本0.6.1文档
version_sidebars --历史版本文档侧边栏
  - version-0.6.0-sidebars.json --历史版本文档侧边栏
  - version-0.6.1-sidebars.json --历史版本文档侧边栏
babel.config.js --babel配置文件
docusaurus.config.js --docusaurus配置文件
package.json --项目配置文件
README.md --项目介绍
sidebars.js --侧边栏配置文件
sidebarsDevelopment.js --侧边栏配置文件
versions.json --版本配置文件

soaped / dinky-website