Code Monkey home page Code Monkey logo

docs's Introduction

HUNT Cloud Documentation

This repository holds HUNT Cloud Documentation source.

Development

VuePress

Prerequisites

How to run VuePress

Install the dependencies of project with:

yarn install --frozen-lockfile

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:

docs's People

Contributors

oddgeih-ntnu avatar matuskosut avatar jakubntnu avatar dependabot[bot] avatar tommentnu avatar mvaudel avatar skarrea avatar snowpong avatar szeestraten avatar bramburger avatar gunnhilv avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.