https://github.com/snyk/driftctl-docs
Docs site for driftctl
https://github.com/snyk/driftctl-docs
docs docusaurus driftctl infrastructure-as-code react
Last synced: 4 days ago
JSON representation
Docs site for driftctl
- Host: GitHub
- URL: https://github.com/snyk/driftctl-docs
- Owner: snyk
- License: mit
- Created: 2021-02-17T15:32:55.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T08:12:28.000Z (18 days ago)
- Last Synced: 2025-04-11T10:34:29.261Z (18 days ago)
- Topics: docs, docusaurus, driftctl, infrastructure-as-code, react
- Language: MDX
- Homepage: https://docs.driftctl.com
- Size: 25.9 MB
- Stars: 6
- Watchers: 54
- Forks: 14
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Documentation website for driftctl
https://docs.driftctl.com
This website is built using [Docusaurus 3](https://docusaurus.io/blog/releases/3.0), a static site generator for documentation sites.
## Get Started
1. Make sure all the dependencies for the website are installed:
```shell
# Install dependencies
$ npm install
```
2. Run your dev server:
```shell
# Start the site
$ npm start
```
This 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.
## Documentation
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:
```yaml
---
id: doc-markdown
title: Markdown File
---
```
For more attributes of the front matter, click [here](https://v2.docusaurus.io/docs/next/api/plugins/@docusaurus/plugin-content-docs#markdown-frontmatter)
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-` directory, whose content is published to `https://docs.driftctl.com`.
## Static Build
To create a static build of the website:
```shell
# Build the site
$ npm run build
```
The result will be put in `build/`.
## Contributing
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](https://gist.github.com/201fc2fd188b4a68973998ec30b57686) before the code can be accepted and merged.