https://github.com/termosa/ovrw
https://github.com/termosa/ovrw
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/termosa/ovrw
- Owner: termosa
- Created: 2021-08-21T11:02:21.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-08T20:01:58.000Z (over 4 years ago)
- Last Synced: 2025-07-22T12:49:36.758Z (11 months ago)
- Language: TypeScript
- Size: 119 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Usage
```sh
$ ovrw
$ ovrw project/dir
```
# Principles
1. Ovrw listen for updates in the folder
2. Ovrw finds all MDX files and creates a page for each file
3. Ovrw starts the website that shows all the pages
4. Ovrw updates the site when files are changed, added, or removed
5. Ovrw can export files to serve documentation as a static site
# Roadmap
DONE
1. Run a webpage rendered from one specific MDX file
2. Make page refresh whenever the file is changing
IN PROGRESS
3. Create a tool that will run such webpage for any specified MDX file
TODO
4. Make this tool serve the list of files
5. Add styles