4 ms·
I've been exclusively using Markdown for all docs for several years which I've found to be the most productive format for writing docs. My preferred setup now b
by mythz 5y ago
I've been exclusively using Markdown for all docs for several years which I've found to be the most productive format for writing docs. My preferred setup now being to use VS Code with a browser running a local instance of
https://vitepress.vuejs.org https://vitepress.vuejs.org which instantly live reloads content on each save and renders our custom server components exactly as it looks when published.
Its biggest benefit is its extensibility which lets you embed interactive Vue Components directly in the docs, which we've made liberal usage of in our latest product release with tabbed components & online project creator embedded directly in the release notes, e.g:
https://docs.servicestack.net/releases/v6#todos-mvc https://docs.servicestack.net/releases/v6#todos-mvc
A lighter weight extensibility option is to extend it [1] with custom block-level custom containers using markdown-it-container [2] which lets you create custom markup like this:
::: nuget
`<PackageReference Include="ServiceStack.OrmLite.PostgreSQL" Version="6.*" />`
:::
::: sh
x mix postgres
:::
Which gets rendered into custom copy widgets as seen in:
https://docs.servicestack.net/ormlite/installation https://docs.servicestack.net/ormlite/installation
Source:
https://raw.githubusercontent.com/ServiceStack/docs/master/docs/ormlite/installation.md https://raw.githubusercontent.com/ServiceStack/docs/master/d...
Markdown all text things!
Basically if it needs to capture text content, I'll look for the Markdown version if it exists, which extends into my preferred TODO App: https://notable.app https://notable.app - a beautiful little App that manages a static directory of *.md files. My first TODOs replacement of using notepad.exe that's stuck.
[1] https://vitepress.vuejs.org/guide/markdown.html#advanced-configuration https://vitepress.vuejs.org/guide/markdown.html#advanced-con...
[2] https://github.com/markdown-it/markdown-it-container https://github.com/markdown-it/markdown-it-container