Skip to main content

Demo Intro

CMKS是一个知识库文档服务的Demo，主要是对服务应用的核心功能进行演示。

Data Structure Intro​

CMKS的数据层面分为三层：

  • 底层数据库
  • 数据对象管理平台
  • 数据文档站（即本网站）

CMKS的主要业务流程基于数据对象管理平台进行，数据对象管理平台中，构建了不同类型的数据对象（因其数据结构存在差异）并进行管理，同时构建了对象关系库以及索引库便于引用和查找。 CMKS通过数据转换层将数据对象管理平台中的对象按一定规则转换为MDX文档，这些文档由Docusaurus服务转为为最终的数据文档站。

What you'll need​

  • Node.js version 20.0 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Generate a new site​

Generate a new Docusaurus site using the classic template.

The classic template will automatically be added to your project after you run the command:

npm init docusaurus@latest my-website classic

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

The command also installs all necessary dependencies you need to run Docusaurus.

Start your site​

Run the development server:

cd my-website
npm run start

The cd command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.

The npm run start command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Open docs/intro.md (this page) and edit some lines: the site reloads automatically and displays your changes.