docs-server

Docs-server

A server which is used to build a kind of microservices for docs system.

Feature

• Perform automatic markdown searching and generate correct dynamic routes according to the root path of your project.

• Support multiple-level documentation routes.

• Support for specifying additional static resources routes.

Installing

# yarn
yarn add docs-server

# npm
npm i docs-server

Usage

• Simple running

const DocsServer = require('docs-server')

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

or

const DocsServer = require('docs-server')()

• ( Optional ) You can specify your custom configuration.

const resolve = require('path').resolve
const DocsServer = require('docs-server')

// Notice: all options is optional
const app = new DocsServer({
  // should be nodejs current working directory
  cwd: resolve('./'),

  // the output path of catalog files (based on current working directory)
  dest: resolve('./menu.json'),

  // your server running port
  port: '8800',

  // extra static resource routes
  extra: [
    {
      route: '/test', // eg. http://locahost:8800/test
      middleware: async (ctx, next) => {
        // do something
      }
    }
  ]
})

• Test you building

# test your server
curl -v http://localhost:8800  # response from /
curl -v http://localhost:8800/doc/sample # response from /doc/sample

CHANGELOG

CHANGELOG

Changelog

1.0.2 (2018-08-05)

<a name="1.0.1"></a>