An open API service indexing awesome lists of open source software.

https://github.com/netoftrees/docs-assembler-help

HELP: Complex knowledge as clear maintainable docs. Reusable components. Decision trees. Zero lock-in.
https://github.com/netoftrees/docs-assembler-help

decision-trees docs-as-code documentation knowledge-management markdown static-site-generator technical-writing vscode-extension

Last synced: 26 days ago
JSON representation

HELP: Complex knowledge as clear maintainable docs. Reusable components. Decision trees. Zero lock-in.

Awesome Lists containing this project

README

          


www.netoftrees.com/docs-assembler-help

## Works With Docs Assembler 0.8.1

To run this repo you need [VS Code](https://code.visualstudio.com/download) with the [Docs Assembler](https://marketplace.visualstudio.com/items?itemName=netoftrees.documentation-assembler) extension installed.

The markdown files that GitHub Pages uses are in `docs`
Maps are stored in `tsmaps`.

Use the Docs Assembler extension:
- To publish the maps as markdown files to `pub`.
- Compare the published files with the live files.
- Copy the contents of `pub` to `docs`.
- Run a git commit.
- Push changes to GitHub.
- Wait for the GitHub Action `pages build and deployment` to complete.
- Browse to the repo's GitHub pages url.