Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 878 Bytes

README.md

File metadata and controls

35 lines (23 loc) · 878 Bytes
Raw

logo-cn

Handbook

This website is built using Docusaurus, a modern static website generator.

How do use it?

# Install
git clone https://github.com/Websoft9/handbook
cd handbook
yarn install

# Development 
npm run start -- --host 0.0.0.0  --port 3002
npm run start -- --host 0.0.0.0  --port 3002  --locale en

# Build
yarn build
npm run serve -- --host 0.0.0.0  --port 3002

# Create i18n language
yarn run write-translations -- --locale zh-cn

# Upgrade Docusaurus 
yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest

Markdown

  • 在标准 Markdown 基础上，支持 Mermaid 来渲染图表
  • 部分文档采用 Markdown 富语法（mdx）