reftel / aurora

Documentation for the Aurora Platform

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Aurora

Documentation for The Aurora Platform

Initial setup

How to build

The project is built using npm from the current Node LTS. Install with nvm;

nvm install --lts

Then run

npm ci

to install the dependencies.

npm start

will start a local web server and continuously build the documentation as you make changes.

Deploying to github pages

Before deploying, you need to set a jekyll theme in the GitHub Pages settings (see https://github.community/t/github-pages-are-not-published-after-following-the-documentation/10555). The "minimal" theme works fine.

To update the gh-pages branch and in turn publish to https://skatteetaten.github.io/aurora/ run

npm deploy

About

Documentation for the Aurora Platform

License:Apache License 2.0


Languages

Language:JavaScript 60.8%Language:CSS 39.2%