Tool + CLI for docs generation from TSDocs
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
There are many awesome macros you can use in your TDDocs. Using macros look like this [[[macro and args]]]
Variable | Description |
---|---|
[github](/core3-utils/docs-macros.github.html) | A link to the package on github Usage: inside a ts-docs comment block: `[[[github caption?]]]` |
[githubBuildStatus](/core3-utils/docs-macros.githubbuildstatus.html) | A github build status badge Usage: inside a ts-docs comment block: `[[[githubBuildStatus]]]` |
[githubPages](/core3-utils/docs-macros.githubpages.html) | 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](/core3-utils/docs-macros.gitrepo.html) | 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](/core3-utils/docs-macros.h.html) | 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](/core3-utils/docs-macros.include.html) | Include another markdown file (that may also have macros) Usage: inside a ts-docs comment block: `[[[include path]]]` |
[listMacros](/core3-utils/docs-macros.listmacros.html) | Lists all the available macros Usage: inside a ts-docs comment block: `[[[listMacros]]]` |
[npmBadge](/core3-utils/docs-macros.npmbadge.html) | A npm version badge Usage: inside a ts-docs comment block: `[[[npmBadge]]]` |
[packageName](/core3-utils/docs-macros.packagename.html) | 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](/core3-utils/docs-macros.packagenameurl.html) | 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](/core3-utils/docs-macros.rootpackagename.html) | Project's root package name Usage: inside a ts-docs comment block: `[[[rootPackageName]]]` |
[unscopedPackageName](/core3-utils/docs-macros.unscopedpackagename.html) | 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` |
npm i @wixc3/docs
npx docs init
git push
npx docs build
npx docs readme
Function | Description |
---|---|
[buildDocs(config, steps, macros)](/core3-utils/docs.builddocs.html) | Build docs markdown |
[cli()](/core3-utils/docs.cli.html) | |
[createReadme(config, siteUrl)](/core3-utils/docs.createreadme.html) | |
[init(config, force)](/core3-utils/docs.init.html) | Initialize docs pre-requisites: - Adds api-extractor.json to packages - Adds git pages action - Creates configs and templates in docs-config |
Type Alias | Description |
---|---|
[BuildSteps](/core3-utils/docs.buildsteps.html) | |
[Macros](/core3-utils/docs.macros.html) | |
[UserConfig](/core3-utils/docs.userconfig.html) |