• ToC
• create
• start
• classic template
• offline search
• Docs
• client redirect
• category.json
• Versions

ToC¶

https://docusaurus.io/docs/cli#docusaurus-write-heading-ids-sitedir

npx docusaurus write-heading-ids

https://docusaurus.io/docs/markdown-features/toc#heading-ids

The --syntax option lets you choose which syntax you prefer: - classic syntax for {#headingId} - mdx-comment syntax for {/* #headingId */}

https://docusaurus.io/docs/api/themes/configuration#table-of-contents

minHeadingLevel 2~6 # can't be 1

create¶

npx create-docusaurus@latest [project]
# will ask template: classic / git url / local

npx create-docusaurus@latest [project] classic --typescript

    ### Hello World <!-- #my-explicit-id -->
    ### MDX {/* #my-explicit-id */}

start¶

https://docusaurus.io/docs/cli

• start : Webpack Dev Server

  npm run start – –host 0.0.0.0 # dev/HMR , no: anchor links / search index npm run build && npm run serve # prod docusaurus deploy # build + git push

classic template¶

https://docusaurus.io/docs/installation#scaffold-project-website - standard documentation, - a blog - custom pages - CSS framework (with dark mode support)

offline search¶

https://docusaurus.io/community/resources#search

https://github.com/cmfcmf/docusaurus-search-local

npm install @cmfcmf/docusaurus-search-local

# docusaurus.config.js
plugins: ["@cmfcmf/docusaurus-search-local"],

Docs¶

• https://opensource.fb.com/projects/docusaurus/
• https://docusaurus.io/docs/creating-pages
• Docs Only: https://docusaurus.io/docs/docs-introduction#docs-only-mode
• Blog Only: https://docusaurus.io/docs/blog#advanced-topics
• Offline Search: https://docusaurus.io/docs/search#using-local-search
• draw / mermaid: https://docusaurus.io/docs/markdown-features/diagrams

client redirect¶

src/pages/index.js # rm src/pages/*

import React from 'react';
import {Redirect} from '@docusaurus/router';

export default function Home() {
return <Redirect to="/docs/2006/sites/" />;
};

category.json¶

https://docusaurus.io/docs/sidebar/autogenerated#category-item-metadata

{
"position": 1,
"collapsed": false
}

Versions¶

3.0.1 (2023-11-30)
2.0.1 (2022-08-01)
1.14.7 2021-03-09