https://github.com/digital-blueprint/handbook

https://github.com/digital-blueprint/handbook

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/digital-blueprint/handbook
• Owner: digital-blueprint
• License: other
• Created: 2023-04-12T12:22:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-30T09:02:57.000Z (8 months ago)
• Last Synced: 2024-05-01T21:16:58.904Z (8 months ago)
• Language: Shell
• Homepage: https://handbook.digital-blueprint.org/
• Size: 24 MB
• Stars: 0
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# digital blueprint - Handbook

[Website](https://handbook.digital-blueprint.org/)

This handbook contains the documentation for the digital blueprint project.

## Build and run this Documentation

Clone the submodules:

* `git submodule init`

* `git submodule update`

Using poetry:

* `poetry install`

* `poetry run mkdocs serve --dev-addr 127.0.0.1:8011`

* 

Using docker-compose:

* `cd docker-dev`

* `docker-compose up`

* 

## Update the submodules

* `git submodule foreach git checkout main`

* `git submodule foreach git pull`

* Sync "nav" in mkdocs.yml

## Add modules to the documentation

* `git submodule add `

* Create symlink to the `/docs` directory of the new submodule using  a relative path (`ln -s ../ bundle-name`)

* Add a section with your new `.md` files in `mkdocs.yml`