8f57ab6365
|
||
|---|---|---|
| .circleci | ||
| assets | ||
| content/v2.0 | ||
| data | ||
| deploy | ||
| docs-v2@fb6e0a3224 | ||
| layouts | ||
| static | ||
| .gitignore | ||
| .s3deploy.yml | ||
| CONTRIBUTING.md | ||
| README.md | ||
| config.toml | ||
README.md
InfluxDB 2.0 Documentation
This repository contains the InfluxDB 2.x documentation published at docs.influxdata.com.
Contributing
We welcome and encourage community contributions. For information about contributing to the InfluxData documentation, see Contribution guidelines.
Run the docs locally
The InfluxData documentation uses Hugo, a static site generator built in Go.
Clone this repository
Clone this repository to your local machine.
Install Hugo
See the Hugo documentation for information about how to download and install Hugo.
Install NodeJS & Asset Pipeline Tools
This project uses tools written in NodeJS to build and process stylesheets and javascript. In order for assets to build correctly, install NodeJS and run the following command to install the necessary tools:
npm i -g postcss-cli autoprefixer
Start the hugo server
Hugo provides a local development server that generates the HTML pages, builds
the static assets, and serves them at localhost:1313.
Start the hugo server with:
hugo server
View the docs at localhost:1313.