https://github.com/pekkah/tanka-docs-gen

Documentation generator
https://github.com/pekkah/tanka-docs-gen

Last synced: about 2 months ago
JSON representation

Documentation generator

• Host: GitHub
• URL: https://github.com/pekkah/tanka-docs-gen
• Owner: pekkah
• License: apache-2.0
• Created: 2018-12-14T10:31:20.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-06-07T04:57:57.000Z (over 1 year ago)
• Last Synced: 2024-03-27T09:47:28.030Z (9 months ago)
• Language: C#
• Homepage: https://pekkah.github.io/tanka-docs-gen/
• Size: 343 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Tanka Documentation Generator

- [![master](https://dev.azure.com/tanka-ops/docs-gen/_apis/build/status/docs-gen?branchName=master)](https://dev.azure.com/tanka-ops/docs-gen/_build/latest?definitionId=2&branchName=master)

Latest

- [Documentation](https://pekkah.github.io/tanka-docs-gen)

## Install

1. Install the global tool

```bash

dotnet tool install --global Tanka.DocsGen

```

2. Add tanka-docs.yml configuration file to root of your repo

3. Add some sections with markdown docs and tanka-docs-section.yml

4. Run the tool in the directory with tanka-docs.yml

```bash

tanka-docs

```

4. 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

```bash

dotnet serve

```