berndbohmeier/clientlib-docs

trustlines-network clientlib react-docs

Repository of the documentation page of the trustlines-network clientlib Javascript library. It uses react-docs to render the documentaion of the Typescript project trustlines-network/clientlib.

Install Dependencies

yarn install

Run dev server

yarn dev

Build

yarn build

Clean

yarn clean

Lint

yarn lint

Deploy to gh-pages

yarn deploy

How to add or change documentation content

All text files are .mds in the /md folder. You can modify existing documenation text in the individual files.

To add a new .md file, you need to add your new files to ts/docs.tsx:

1. Link newly created md file by defining const after import * as v0TypeDocJson from './json/x.x.x.json';
2. Add new sections in const docSections = {
3. Define the order of the added sections in const docsInfoConfig: DocsInfoConfig = {
4. Add ... after sectionNameToMarkdown: {
5. Define the heading for the new section in sectionNameToModulePath: {
6. Add ... after typeNameToDocSection: {