Document your Shell Scripts with MarkDown
Run each Shell Command in a Web based Terminal
Write in MarkDown
- MarkDown syntax & Custom Widgets
- Get User Input as Parameters
- Use Parameters in Shell Commands & templates
- Quickly insert blocks
- Live HTML Preview in the Editor
Save as HTML Document
- Stand-alone HTML Document with all the dependencies included
- It works in almost any web Browser (no Internet connection needed)
- You can use it as dynamic Documentation
Run in a Web based Terminal
- Load a MarkDown/HTML Document - compatible with ReactiveDoc
- Run each shell command in the Web based Terminal
- Create custom Regex Filters
- Create custom Selection Actions (Activated when you select something in the Terminal)
- Save History as MarkDown/HTML Document
- Export Logs
Coming soon...
Download or clone this repository, then:
cd src/client
yarn install
cd ../server
yarn install
cd ..
sh ./build.sh
cd server
yarn dev
Open a browser & go to http://localhost:23000/