CLI
Basic Usage
speed-docs <content-directory>This will build your documentation in the content-directory and copy the built documentation to the docs-output directory. You can then deploy the docs-output directory to any static hosting service.
Development Mode
speed-docs <content-directory> --devThis will start a development server and watch for changes in your content directory. Any changes will be reflected in the documentation immediately.
Custom Template
speed-docs <content-directory> --template <template-url>This will use a custom template instead of the default template. The template URL should be a URL to a tarball of a template repository.
Custom Download Directory
speed-docs <content-directory> --download-dir <path>Speed docs will download the template to the tmp directory of your machine. You can override the default download directory by using this option.
Custom Base Path
speed-docs <content-directory> --base-path <path>You can override the default base path by using this option. The base path is the base path of the documentation. For example, if you want to deploy your documentation to https://example.com/my-docs, you can use --base-path /my-docs.
Force Download
speed-docs <content-directory> --forceBy default, speed docs will check if the template is already downloaded. If it is, it will use the cached template. You can force the download of the template by using this option.
Include Hidden Files and Folders
speed-docs <content-directory> --include-hiddenBy default, speed docs will ignore hidden files and folders. You can include hidden files and folders by using this option.