@wixc3/docs

@wixc3/docs on Github

Home > @wixc3/docs

docs package

Tool + CLI for docs generation from TSDocs

Remarks

Templates

Site pages includes the following templates from docs-config:

• index.md - main page header

• package.md - packages root page header

• item.md - header for other files

Macros

There are many awesome macros you can use in your TDDocs. Using macros look like this \[[[macro and args]]]

Available macros are:

• [[[gitRepo]]]
• [[[github]]]
• [[[githubBuildStatus]]]
• [[[githubPages]]]
• [[[h]]]
• [[[include]]]
• [[[listMacros]]]
• [[[npmBadge]]]
• [[[packageName]]]
• [[[packageNameUrl]]]
• [[[rootPackageName]]]
• [[[unscopedPackageName]]]

Example 1

Generate automatically updated github pages

yarn add @wixc3/docs
yarn docs init
git push

Example 2

Build documentation locally

yarn docs build

Example 3

Generate README.md in all packages (after docs build)

yarn docs readme

Functions

Function	Description
buildDocs(conf, skipAnalyze, macros)	Build docs markdown
cli()
createReadme(conf, siteUrl)
init(config, force, overrideOrigin)	Initialize docs pre-requisites: - Adds api-extractor.json to packages - Adds git pages action - Creates configs and templates in docs-config