@wixc3/docs NPM

@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 githubUsage: inside a ts-docs comment block:[[github caption?]]
githubBuildStatus	A github build status badgeUsage: inside a ts-docs comment block:[[githubBuildStatus]]
githubPages	A link to the project's github pagesUsage: inside a ts-docs comment block:[[githubPages uri? caption?]]where uri can be an inner pageif 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 formatUsage: 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 #, ##, ## etcUsage: 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 macrosUsage: inside a ts-docs comment block:[[listMacros]]
npmBadge	A npm version badgeUsage: inside a ts-docs comment block:[[npmBadge]]
packageName	Project's current package nameUsage: inside a ts-docs comment block of a package:@wixc3/docsWill be replace by the full package name, i.e @wixc3/docs-macros
packageNameUrl	Project's current package name, in a url friendly formatUsage: inside a ts-docs comment block of a package:[[packageNameUrl]]This is useful for generating links and badges
rootPackageName	Project's root package nameUsage: inside a ts-docs comment block:[[rootPackageName]]
unscopedPackageName	Project's current package name, unscopedUsage: inside a ts-docs comment block of a package: *docsWill be replace by the full package name, i.e bla for @wixc3/bla

Example 1

yarn add @wixc3/docs
yarn docs init
git push

Example 2

yarn docs build

Example 3

yarn docs readme

Functions

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