Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.72 KB
Raw

Contributing to Altinn docs

The Altinn docs site is generated from markdown using the Hugo static site generator.

Instructions

Initial setup

  1. Download and install Git and clone the docs repository to a local folder.
  2. We also recommend downloading and using vs code for editing markdown
  3. Download Hugo (version 0.21 or newer) for your platform, and place it in the same folder named as "hugo.exe"

Build / Edit / Test

  1. Open the docs repo-folder in vs code (or another editor)
  2. Run hugo -serve or click "Run Altinn docs" (Ctrl-Shift-D) in vs code. This generates the site and opens Chrome at http://loalhost:1313/docs
  3. Edit any markdown (.md) file in the content-folder to get a new build of the docs site refreshed in your browser. We use YAML as front matter.

Deploy

Whenever changes are pushed to the docs-repository, an automatic build is triggered 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