This website is built using Docusaurus 2, a static site generator for documentation sites.
- Make sure all the dependencies for the website are installed:
# Install dependencies
$ npm install- Run your dev server:
# Start the site
$ npm startThis starts a server hosting the website locally at http://localhost:3000/. Any changes to the site's source files are reflected after refreshing the page, i.e. the server does not need to be restarted to show changes.
At the root of the repository, the docs directory is used to hold documentation written in Markdown. The front matter of new documentation files should at least follow this example:
---
id: doc-markdown
title: Markdown File
---
For more attributes of the front matter, click here
The docs are published to https://docs.driftctl.com/next/ and are considered to be the docs of the next (not yet released) version of driftctl. When a release happens, the docs are copied to the website/versioned_docs/version-<version> directory, whose content is published to https://docs.driftctl.com.
To create a static build of the website:
# Build the site
$ npm run buildThe result will be put in build/.
Should you wish to make a contribution please open a pull request against this repository with a clear description of the change with tests demonstrating the functionality. You will also need to agree to the Contributor Agreement before the code can be accepted and merged.