README.md

Welcome to MkDocs

The documentation is hosted in navikt.github.io/dbt-i-nav

For full documentation visit mkdocs.org and material.

Installation

Requirements

• python v3

macOS / Linux

make

Windows

pip install -r requirements-doc.txt

Commands

• source .venv/bin/activate - Activates venv on macOS / Linux
• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

When creating a new site you need to add it under nav in mkdocs.yml. See doc for more info.