docusaurus-api-template

for api of

features

• docusaurus 3.17+ https://docusaurus.io/docs
• management by pnpm
• close blog, and keep docs

GUI features

• hidden and foldable side column record
• Math Equations
  • support remark-math
  • support rehype-katex
• support mermaid https://mermaid.js.org/#/./n00b-syntaxReference -@docusaurus/theme-mermaid
• TOC of markdown support level 2 (docusaurus support level 2-6)
• sitemap auto build by plugin @docusaurus/plugin-sitemap
• add docusaurus-search-local
  • only at build version show search
• ideal-image https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-ideal-image
  • when use pnpm install will let https://sharp.pixelplumbing.com/ bug with cross-platform
    • fix from #11173 by pnpm onlybuiltdependencies

env

• node >=20.17.0
• pnpm 10.10.0
• build out folder is build

usage

by makefile

# first run
$ make init

# run local
$ make run
# run local build
$ make run.build

more usage see

• usages/README.md