This is a quick-and-dirty demo of what the tech writers are looking for in a single-sourcing tool. The demo uses Markdoc (created by Stripe).
This demo:
- Showcases a very basic example of what we can do with a single-sourcing utility.
- Demonstrates the functionality we need.
It doesn't:
- Advocate for Markdoc specifically.
- Advocate for having the writers work in any particular source.
- Clone this repo:
git clone https://github.com/imnotashrimp/markdoc-test.git. cdtomarkdoc-testand runnpm install.- Start the server:
npm run dev.
You can then point your browser to localhost:3000/docs/<PAGE> to see a sample page. Replace <PAGE> with the base filename of a markdown file in the folder /pages/docs. For example, to render /pages/docs/create-contact.md, go to localhost:3000/docs/create-contact.
To live-change the content:
- Open
output.config.jsin your editor. - Change
targetto'rest'or'velo'and save. - Set
internaltotrueorfalseand save.
Every time you save, the site rebuilds and reloads.