An app that transforms your boring markdown files into clean & simple presentations
- JavaScript 98.3%
- HTML 1.6%
- CSS 0.1%
| .idea | Add recursive parsing of list items | |
| public | Add draft version | |
| src | Add optional markdown source file download directly from web | |
| .gitignore | Add optional markdown source file download directly from web | |
| eslint.config.js | Add draft version | |
| example.md | Add example.md & update README | |
| index.html | Fix rendering of lists | |
| LICENSE | Initial commit | |
| package-lock.json | Update dependencies | |
| package.json | Add draft version | |
| README.md | Add optional markdown source file download directly from web | |
| vite.config.js | Add draft version | |
read.md
An app that transforms your boring markdown files into clean & simple presentations
The app currently supports rendering of:
- presentation titles
- chapters
- subchapters
- lists of any depth
- images
- code blocks
Check the example.md file to learn how to organize your source file
You can use it right away
To test the application locally you just have to:
cd read.md
npm install
npm run dev
Obtaining a proper production-ready build is as easy as:
npm run build
An optional feature to download the content of a markdown file directly from the web is available only if a cors-dumper server is available too
To enable this feature, create a .env file in the root directory and populate it as:
VITE_CORS_DUMPER_URL=http://your-cors-dumper?url=
I published cors-dumper implementation here