Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.76 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. Download and install Git and clone the docs repository to a local folder:
git clone https://github.com/altinn/docs
  1. We recommend downloading and using visual studio code with this extension for editing markdown.
  2. Download Hugo for your platform, and place the executable in the docs-folder.

Build / Edit / Test

  1. Open the docs repo-folder in visual studio code (or another editor)
  2. Run hugo server --navigateToChanged or click "Altinn docs" (Ctrl-Shift-D) in vs code. This generates the site and opens Chrome at https://loalhost: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