Skip to content

Konrad-Simso/altinn-studio-docs

 
 

Repository files navigation

Altinn Studio docs

Build and Deploy

This repo contains the source for the Altinn 3 documentation.

There are two ways to edit and test your changes to the docs:

Github.dev in your browser

For minor changes to content in a few files, text and typos, translations, cleanups, etc.

  1. Open the page you want to change at https://docs.altinn.studio and click the "Edit page on GitHub"-link at the bottom to open github.dev (Visual Studio Code) in your browser
  2. Open preview and do your changes
  3. When happy with your changes, add a message (1), Commit & Push (2) and create a Pull Request (3).
    image
    (if you're on the master branch, you'll first be asked to name a new branch)

Running Hugo locally

When doing larger changes, restructuring and refactoring, changes in layouts, code, etc. See CONTRIBUTING for even more details.

  1. Install the required software (Git, Hugo and Visual Studio Code)
  2. Clone the repo
    cd C:/repos
    git clone https://github.com/altinn/altinn-studio-docs
  3. Navigate to folder and run Hugo
    cd altinn-studio-docs
    hugo server --navigateToChanged
  4. The documentation can now be opened in browser at http://localhost:1313
  5. Edit and save files to get the site refreshed in your browser, so you can test your changes
  6. When happy, push your changes

Releases

No releases published

Packages

No packages published

Languages

  • CSS 54.2%
  • JavaScript 26.3%
  • HTML 14.0%
  • SCSS 5.2%
  • Shell 0.3%