docs-server

Docs-server

A server which is used to build a microserver for docs system.

Feature

• Automatic search markdown files and generate correct dynamic route according to root path.

• Support for specifying additional static routes.

Notice

Only support second-level directory temporarily.

Your project structure should be like this:

├── doc [custom directory name]
|    ├── a.md
|    ├── b.md
|    ├── c.md
|    └── d.md
|
├── docs-server.config.js [define your custom config]
|
├── something.json [additional static route]
|
...
└── package.json

Usage

1. You should specify your documents directory.

// docs-server.config.js
const send = require('koa-send')
const resolve = require('path').resolve

module.exports = {
  // documents directory (required)
  // based on root path
  docsPath: 'doc',

  // extra static file route (optional)
  routes: [
    {
      path: 'menu',
      callback: async (ctx, next) => {
        await send(ctx, './menu.json', {
          root: resolve(__dirname, './')
        })
      }
    },
    {
      path: 'something',
      callback: async (ctx, next) => {
        await send(ctx, './something.json', {
          root: resolve(__dirname, './')
        })
      }
    }
  ]
}

1. Import module and run it

const DocsServer = require('docs-server')

// It should be running at http://localhost:8800 by default
const app = new DocsServer()

1. ( Optional ) You can specify output path of catalog file ( menu.json ) and server port.

const app = new DocsServer({
  catalogOutput: path.resolve(__dirname, './')
  port: '3000'
})