はじめに

このページは mdocbuilder をどう使うかを最短で把握するためのガイドです。

1. インストール

公開後は使う側のリポジトリで以下を実行します。

npm install -D mdocbuilder

2. 設定ファイルを置く

プロジェクトルートに mdocbuilder.config.mjs を置きます。

export default {
  siteName: "My Docs",
  docsDir: "docs",
  outDir: "dist",
  basePath: "/",
  github: {
    repoUrl: "https://github.com/owner/repo",
    branch: "main",
    sourceRoot: "docs-app",
  },
  theme: {
    customCss: "./docs-theme.css",
  },
};

3. docs を書く

最低限これだけで動きます。

docs/
  index.md
  guide/
    intro.md

4. build する

npx mdocbuilder build

または package.json に script を置きます。

{
  "scripts": {
    "docs:build": "mdocbuilder build"
  }
}

5. 何が生成されるか

• dist/**/*.html
• dist/search-index.json
• dist/site-data.json
• dist/assets/*

この repository での見方

この repository では root がライブラリ本体、sample/ が利用側プロジェクトです。

• root: mdocbuilder のソースコード
• sample/docs/: サンプル Markdown
• sample/package.json: ライブラリを install して使う側

ローカルでは以下で sample を build できます。

npm run sample:build