cli

TL;DR

The package contains the cli commands and the main dependencies of the docusaurus-tde.

Integration:

1. Add dependency

yarn

yarn add -WD "@docusaurus-tde/cli"

npm

npm i "@docusaurus-tde/cli"

2. Create a config

Create a directory docs in the root of the repository, and in it docusaurus-tde.config.js

3. Configure the config

docs/docusaurus-tde.config.js

module.exports = {
  navbar: {
    support: {
      url: '<link>', // link to the support page
    },
    repository: {
      url: '<link>', // link to the repository
    },
  }
}

4. Start the documentation

Execute the following command in the root of the repository:

yarn

yarn docusaurus-tde start

npm

npm run docusaurus-tde start

After the build, the documentation should be available at http://localhost:3000. For now, the documentation will be empty.

Commands:

Running the documentation app in development mode:

yarn

yarn docusaurus-tde start

npm

npm run docusaurus-tde start

Parameters:

• --config <configPath = './docs/docusaurus-tde.config.js'>
• --help

---

Build the documentation app to the <root>/build directory:

yarn

yarn docusaurus-tde build

npm

npm run docusaurus-tde build

Parameters:

• --config <configPath = './docs/docusaurus-tde.config.js'>
• --help

---

Hosting the documentation app from the <root>/build directory:

yarn

yarn docusaurus-tde serve

npm

npm run docusaurus-tde serve

Parameters:

• --config <configPath = './docs/docusaurus-tde.config.js'>
• --help

---

Create a template file for the documentation:

yarn

yarn docusaurus-tde create

npm

npm run docusaurus-tde create

Parameters:

• --config <configPath = './docs/docusaurus-tde.config.js'>
• --structure - Initialize the structure of the documentation.
• --migration - Initialize the migration guide.
• --help