Front-end project documentation web site generation tool

The Rainie-doc tool automatically generates a document static website based on annotations.

The characteristics of

  • Generate static HTML pages from code comments
  • Markdown files can be added to generate HTML pages
  • The reservedDirections for useandFunction DescriptionConfigure HTML page generation

introduce

options

The configuration file

Configuration file rainie-doc.json template:

{
  "github_url": "https://github.com/lanjingling0510/rainie-doc"."name": "Document Web automatic generation tool"."title": ""."description": "Automatically generate description sites based on code comments"."logo_icon": ""."entry_path": "./src/*.js"."categories": [
    "introduce"."API"]."staticDocs":[{"type": "markdown"."urlId": "readme"."category": "introduce"."title": "readme"."description": ""."path": "README.md"}]."feature": "Feature.md"."usage": "./docs/usage.js"
}
Copy the code

For details, see the configuration file description