The site is generated from markdown using the Hugo static site generator. We use YAML as front matter.
- Download and install Git and clone the altinn-studio-docs repository to a local folder:
git clone https://github.com/Altinn/altinn-studio-docs- We recommend downloading and using visual studio code with
- this markdown extension for editing markdown and
- the github extension for helping with pull requests
- Download the latest Hugo (extended) for your platform, and place the executable in the altinn-studio-docs folder.
- Open the altinn-studio-docs repo-folder in visual studio code
- Run
./hugo server --navigateToChanged. Now the docs is running locally at http://loalhost:1313/ - Edit and save files in the
content-folder to automatically get a new local build of the site refreshed in your browser, so you can test your changes locally.
We recommend that you create a pull request when you want to share your changes with the rest of the world.
- Create a branch for your changes
- Create a pull request
Whenever changes from your pull request are merged into the main-branch, an automatic deploy is updating https://docs.altinn.studio/
PS: If you don't have direct write access to the repo, you need to create a fork and submit a pull request from your fork.
Remember to follow our code of conduct.