Skip to content

mkoertgen/hello.nplant

Repository files navigation

docs

hello.nplant

An example on Continuous Documentation - introducing a feedback loop for documentation as part of your build. This example shows how you can generate

  • full blown documentation using mkdocs
  • architectural documentation that lives with your code using NPlant & plantuml
  • UI sketches & prototypes for use cases with Salt

Install

You will need

choco install plantuml
choco install python -y
pip install --user -r requirements.txt

Build documentation

Build the documentation using

dotnet build

The documentation is built into the \site subdirectory. Best way to view is

python -m mkdocs serve

and browse to http://localhost:8000. Note that changes in the markdown documentation files within \docs are automatically tracked by mkdocs rebuilding & refreshing the served documentation.

About

An example on how to use NPlant for generating class diagrams in a CI-friendly way.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published