Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexwkleung/nordrise
A web-based Markdown editor demo
https://github.com/alexwkleung/nordrise
codemirror6 demo-app markdown markdown-editor nord-theme typescript-react vite
Last synced: about 17 hours ago
JSON representation
A web-based Markdown editor demo
- Host: GitHub
- URL: https://github.com/alexwkleung/nordrise
- Owner: alexwkleung
- License: mit
- Created: 2022-08-27T18:03:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-03T19:40:21.000Z (about 2 years ago)
- Last Synced: 2023-04-26T01:37:31.380Z (over 1 year ago)
- Topics: codemirror6, demo-app, markdown, markdown-editor, nord-theme, typescript-react, vite
- Language: TypeScript
- Homepage: nordrise.vercel.app
- Size: 2.49 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nordrise
A web-based CodeMirror 6 Markdown editor demo. You can try the demo [here](https://nordrise.vercel.app/).
Code name: Nordrise.
This demo is a bit more rigid and fine-tuned compared to my previous demo [Moonrise](https://github.com/alexwkleung/Moonrise). However there are some differences between them.
1) Uses TypeScript React + Vite instead of Electron + TypeScript. Since it's web-based, you don't need to install anything to try it out.
2) I've added Markdown enhancements via Remark, Rehype, and KaTeX plugins for an improved experience out of the box.
3) The CSS is not as hack-y (and critically broken) compared to Moonrise.
4) It's based off the Nord theme!
**Note:** If you're planning to add Electron into this demo, there might be some issues when combining it with Vite. So if you don't want to go through the hassle to make it work, I recommend switching to Webpack + Babel as a fallback.
**Markdown Plugins:**
- react-syntax-highlighter
- @akebifiky/remark-simple-plantuml
- rehype-katex
- rehype-slug
- remark-emoji
- remark-gfm
- remark-math
- remark-toc
- mhchem (KaTeX)
I plan on adding more features, so feel free to submit any requests.
# Development
Clone the repository
```bash
git clone
```
Change directory
```bash
cd Nordrise
```
Install npm dependencies
```bash
npm install
```
Run Vite
```bash
make dev
#or
npm run dev
```
Building for production:
```bash
make build
#or
npm run build
```