@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]]]

@wixc3/docs on Github

Home > @wixc3/docs-macros

docs-macros package

Variables

Variable	Description
github	A link to the package on github Usage: inside a ts-docs comment block: [[[github caption?]]]
githubBuildStatus	A github build status badge Usage: inside a ts-docs comment block: [[[githubBuildStatus]]]
githubPages	A link to the project's github pages Usage: inside a ts-docs comment block: [[[githubPages uri? caption?]]] where uri can be an inner page if caption is provided a markdown link will be created, otherwise the raw root URL will replace the macro
gitRepo	Project's current package name, in a url friendly format Usage: inside a ts-docs comment block: [[[gitRepo field?]]] where field can be: host | org | repo | pages | github
h	Heading - since ts-docs to not natively allow for markdown formatting, this macro is used to create a #, ##, ## etc Usage: inside a ts-docs comment block: [[[h level title]]]
include	Include another markdown file (that may also have macros) Usage: inside a ts-docs comment block: [[[include path]]]
listMacros	Lists all the available macros Usage: inside a ts-docs comment block: [[[listMacros]]]
npmBadge
packageName	Project's current package name Usage: inside a ts-docs comment block of a package: @wixc3/docs Will be replace by the full package name, i.e @wixc3/docs-macros
packageNameUrl	Project's current package name, in a url friendly format Usage: inside a ts-docs comment block of a package: [[[packageNameUrl]]] This is useful for generating links and badges
rootPackageName	Project's root package name Usage: inside a ts-docs comment block: [[[rootPackageName]]]
unscopedPackageName	Project's current package name, unscoped Usage: inside a ts-docs comment block of a package: *docs Will be replace by the full package name, i.e bla for @wixc3/bla

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

Type Aliases

Type Alias	Description
Macros
UserConfig