README.md

HUNT Cloud Documentation

This repository holds HUNT Cloud Documentation source.

Development

VuePress

Prerequisites

• Node.js v12.x:
• Yarn

How to run VuePress

Install the dependencies of project with:

yarn install

Start a local VuePress development server with:

yarn dev

For more details, please read VuePress's documentation.

Linting and pre-commit hooks

This repository has pre-commit hooks with linting tools that you can use in your local development environment. See pre-commit#install for how to install.

To get started, install the pre-commit hooks inside the repo with the snippet below. Any future commits will then be checked by the checks defined in .pre-commit-config.yaml

pre-commit install

You can also use tox to run the pre-commit hooks with linting which is run in CI. See tox#install for how to install.

tox

VuePress permalinks

I have chosen to specify permalinks in Markdown .md documents to avoid .html routes which seems to be the default as of VuePress 1.0.2 as shown here

I found these issues related to "clean" URLs so it might be fixed in the future:

• vuejs/vuepress#78
• vuejs/vuepress#270
• vuejs/vuepress#608