https://github.com/njs-guy/generic-markdown-reader
A fast and lightweight Markdown reader
https://github.com/njs-guy/generic-markdown-reader
bootstrap bootstrap5 css css3 html html5 javascript markdown markdown-editor markdown-it markdown-viewer typescript vue vuejs
Last synced: 2 months ago
JSON representation
A fast and lightweight Markdown reader
- Host: GitHub
- URL: https://github.com/njs-guy/generic-markdown-reader
- Owner: njs-guy
- License: mit
- Created: 2022-04-25T17:51:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-15T20:24:56.000Z (almost 3 years ago)
- Last Synced: 2024-12-30T22:29:42.677Z (4 months ago)
- Topics: bootstrap, bootstrap5, css, css3, html, html5, javascript, markdown, markdown-editor, markdown-it, markdown-viewer, typescript, vue, vuejs
- Language: Vue
- Homepage: https://njshockey.github.io/generic-markdown-reader/
- Size: 4.16 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Generic Markdown Reader
A fast and lightweight Markdown reader made in Vue and Typescript.
## Current plans
- [x] ~~Parse basic Markdown~~
- [x] ~~Edit Markdown~~
- [x] ~~Open text and Markdown files~~
- [x] ~~Save files as txt, md, or html~~
- [ ] Parse CommonMark + Task lists
- [ ] Basic insert toolbar
# Building from source
1. Clone this repo. Usually with `git clone https://github.com/njshockey/generic-markdown-reader.git`.
2. Open the directory in your terminal or console and install the necessary npm packages with `npm install`.
3. To run the development server to test changes, run `npm run serve` and to build the production version, run `npm run build`. Built files will be in the dist folder.
# Special Thanks
Special thanks goes to the developers and contributors of [markdown-it](https://github.com/markdown-it/markdown-it), [Vue](https://vuejs.org/), and [Bootstrap](https://getbootstrap.com/). Without them, the making of Generic Markdown Reader would have been infinitely harder!