https://github.com/negrel/nwotable
One app for all your notes on all your devices.
https://github.com/negrel/nwotable
codemirror commonmark editor javascript markdown markdown-editor markdown-writer note pwa quasar vue
Last synced: 6 months ago
JSON representation
One app for all your notes on all your devices.
- Host: GitHub
- URL: https://github.com/negrel/nwotable
- Owner: negrel
- License: agpl-3.0
- Created: 2019-09-03T21:00:46.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-07T21:02:13.000Z (over 5 years ago)
- Last Synced: 2025-04-04T03:11:41.271Z (6 months ago)
- Topics: codemirror, commonmark, editor, javascript, markdown, markdown-editor, markdown-writer, note, pwa, quasar, vue
- Language: JavaScript
- Homepage: https://nwotable.negrel.dev/
- Size: 4.08 MB
- Stars: 33
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://lgtm.com/projects/g/Nergel3/Nwotable/context:javascript)[](https://madewithvuejs.com/p/nwotable/shield-link)
# 
| [Nwotable](https://nwotable.negrel.dev/)
#### Introduction
Nwotable is a **PWA** to write markdown (Github Flavored). It currently only support desktop browser but I'm working to make it work on mobile too.
The design is strongly inspired by the [app](https://github.com/notable/notable) of [Fabio Spampinato](https://github.com/fabiospampinato) and if you are looking for a desktop markdown editor you should take a look at his work.
Nwotable v1.0.0 is build with the following awesome technologies :
* Progressive Web App
* [Vue.js](https://vuejs.org/) with [Quasar Framework](https://quasar.dev/) and [Vuex](https://vuex.vuejs.org/)
* [CodeMirror](https://codemirror.net/index.html) for the editor (mobile support)
* [Showdown](https://github.com/showdownjs/showdown) to parse the markdown.
* [IndexedDb API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Using_IndexedDB)
* [Webpack](https://webpack.js.org/)
### Features
Supported features :
* **Markdown** editor (Github Flavored) // 1.0.0
* **Indefinitely** nestable tags // 1.0.0
* **export** or download as :
* **HTML** // 1.0.0
* **Markdown** // 1.0.0
* Filter by :
* **Tag** // 1.0.0
* **Search** // 1.0.0
* **Favorite** // 1.0.0
* **Import local attachment** (**images only** *.jpg, .ext, .png*) // 1.0.0
* Metadata header // 1.0.0
### Release
Check at : https://nwotable.negrel.dev/
### :ballot_box_with_check: TODO
The app is still in development so some features may not work.
Missing features :
* **Mobile** support
* **Fuzzy** search
* Auto delete unused attachment at the starting of the app.
* **Rename** imported attachment
* Live preview (**split mode**).
* Export as a **PDF**
* **Dark Themes**
* Google Drive & Dropbox support (**cloud support**)
* Code syntax highlighting (rendered markdown, **no showdow-highlight**)
### :stars: Show Your Support
Please give a :star: if this project helped you!
### Contributing
If you want to contribute to Nwotable to add a feature or improve the code contact me at [negrel.dev@protonmail.com](mailto:negrel.dev@protonmail.com), open an [issue](https://github.com/negrel/Nwotable/issues) or make a [pull request](https://github.com/negrel/Nwotable/pulls).
#### Set up the dev env.
Clone this repositorie :
```bash
git clone https://github.com/negrel/nwotable.git
```
Install the dependencies :
```bash
cd Nwotable
npm install
```
Start the dev server (with hot reload) :
```bash
npm run dev:pwa
```
Build the app for production :
```bash
npm run build:pwa
```
#### :scroll: License
AGPL-v3 © Alexandre Negrel