@guanghechen/handbook-api v1.0.0-alpha.2

Install

• npm

  npm install --save @guanghechen/handbook-api

• yarn

  yarn add @guanghechen/handbook-api

Usage

• Prepare a workspace directory, for example:

  /home/demo/handbook/doc/
  ├── css
  │   └── box-model
  │       ├── position.md
  │       └── z-index.md
  └── react
      ├── demo.md
      └── hooks
          ├── effect.md
          └── issue.md

• Use @guanghechen/handbook-api in typescript

  import fs from 'fs-extra'
  import path from 'path'
  import {
    HandbookConfig,
    HandbookDataProvider,
    SitePathConfig,
    resolveHandbookConfig,
  } from '@guanghechen/handbook-api'
  
  async function handle(
    workspace: string,
    handbookSourceRoot: string,
    handbookDataRoot: string,
  ): Promise<void> {
    const handbookNames = fs.readdirSync(path.resolve(workspace, handbookSourceRoot))
      .filter(p => fs.statSync(path.resolve(workspace, handbookSourceRoot, p)).isDirectory())
  
    const sitePathConfig: SitePathConfig = { urlRoot: '/', workspace }
    for (const handbookName of handbookNames) {
      const config: HandbookConfig = resolveHandbookConfig(
        {
          urlRoot: `/handbook/${ handbookName }`,
          sourceRoot: path.join(handbookSourceRoot, handbookName),
          dataRoot: path.join(handbookDataRoot, handbookName),
        },
        sitePathConfig,
      )
      const provider = new HandbookDataProvider(config)
      await provider.build()
    }
  }

handle('/home/demo/handbook', 'doc', 'doc-data')

* Then, the generated data will be placed in the `/home/demo/handbook/doc-data/` directory, something like below:

  ```
  /home/demo/handbook/doc-data/
  ├── css
  │   ├── asset.map.json
  │   ├── category.map.json
  │   ├── post
  │   │   ├── ec62f7df24449f80e7a984e10c557f2d50aba760.json
  │   │   └── f5d337022ef180f9fcd4fc0c401e0e99963fe642.json
  │   └── tag.map.json
  └── react
      ├── asset.map.json
      ├── category.map.json
      ├── post
      │   ├── 6d5ad184c9c5a81616173733457d677fcc5e4a42.json
      │   └── b5a99a469e1a68e159ab502291806b8b28933c84.json
      └── tag.map.json
  ```


### Options

## Examples