ScanReach.Docs

A modern user manual written as a website using raw Markdown and Vitepress.

Currently hosted at https://scanreach.github.io/ScanReach.Documentation/

Vitepress docs: https://vitepress.dev/guide/what-is-vitepress

Features:

• Raw text in Markdown format instead of pdf or html
• Accessible on all devices in browser
• Printable to PDF -> Probably need to use cypress or similar to render each site to pdf then merge them
• Searchable -> Press cmd+k or ctrl+k to search
• Short update cycle -> Push to main and it's live
• Version support
• Customiseable

Getting started

1. Install Node.js
2. Open terminal and run npm install
3. Run npm run docs:dev

Edit files

All files are located in the docs folder

Toggle word wrap for easier editing:

• In VSCode: View -> Toggle Word Wrap

Show new file in sidebar:

Open .vitepress/config.mts and add the file to the sidebar array in appropriate place