docs-v2/README.md

41 lines
1.4 KiB
Markdown
Raw Normal View History

2018-12-13 18:47:02 +00:00
# InfluxDB v2.0 Documentation
This is the repository contains the InfluxDB v2.x documentation that will be
2018-12-13 18:47:02 +00:00
accessible at [docs.influxdata.com](https://docs.influxdata.com).
## Contributing
2019-01-18 20:29:39 +00:00
We welcome and encourage community contributions to the InfluxData See our [Contribution guidelines](CONTRIBUTING.md) for information
about contributing to the InfluxData documentation.
2018-12-13 18:47:02 +00:00
## Run the docs locally
The InfluxData documentation uses [Hugo](https://gohugo.io/), a static site
generator built in Go.
### Clone this repository
[Clone this repository](https://help.github.com/articles/cloning-a-repository/)
to your local machine.
2018-12-13 18:47:02 +00:00
### Install Hugo
See the Hugo documentation for information about how to
[download and install Hugo](https://gohugo.io/getting-started/installing/).
2018-12-13 18:47:02 +00:00
2018-12-19 21:40:52 +00:00
### 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](https://nodejs.org/en/download/)
and run the following command to install the necessary tools:
2018-12-19 21:36:12 +00:00
```sh
npm i -g postcss-cli autoprefixer
```
2018-12-13 18:47:02 +00:00
### 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`.
2018-12-13 18:47:02 +00:00
Start the hugo server with:
```bash
hugo server
```
View the docs at [localhost:1313](http://localhost:1313).