Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.39 KB
Raw

Contributing to Altinn docs

The Altinn docs site is generated from markdown using the Hugo static site generator. We use YAML as front matter.

Initial setup

  1. Install Git and clone the docs repository to a local folder:
git clone https://github.com/altinn/docs
  1. Install Visual Studio Code for editing markdown
  2. Install Hugo for your operating system

Build / Edit / Test

  1. Open the docs repo-folder in visual studio code (or another editor)
  2. Run hugo server --navigateToChanged open your browser at http://localhost:1313/docs/
  3. Edit and save a file in the content-folder to get a new local build of the site refreshed in your browser.

Deploy

Whenever changes are pushed to the docs-repository, an automatic deploy is updating https://altinn.github.io/docs/

If you don't have write access to the docs-repo, you need to create a fork and submit a pull request.

Links