Generate static technical documentation site from markdown files


Keywords
tanka, documentation, docs, tool, generator, roslyn, markdown
License
MIT
Install
Install-Package Tanka.DocsGen -Version 0.9.1-beta.2

Documentation

Tanka Documentation Generator

  • master

Latest

Install

  1. Install the global tool
dotnet tool install --global Tanka.DocsGen
  1. Add tanka-docs.yml configuration file to root of your repo
  2. Add some sections with markdown docs and tanka-docs-section.yml
  3. Run the tool in the directory with tanka-docs.yml
tanka-docs
  1. Output will be generated to output (example: gh-pages)

Serve

  1. Install dotnet-serve https://github.com/natemcmaster/dotnet-serve
  2. Run dotnet serve in the output folder
dotnet serve