Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GarliqBread/Noteup
Markup note-taking app
https://github.com/GarliqBread/Noteup
markdown markdown-editor markdown-viewer markup markup-language note-taking notes notes-app noteup react tauri tauri-app
Last synced: 3 months ago
JSON representation
Markup note-taking app
- Host: GitHub
- URL: https://github.com/GarliqBread/Noteup
- Owner: GarliqBread
- License: mit
- Created: 2022-09-11T19:25:13.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-08T19:33:06.000Z (about 1 year ago)
- Last Synced: 2024-06-21T11:30:16.133Z (5 months ago)
- Topics: markdown, markdown-editor, markdown-viewer, markup, markup-language, note-taking, notes, notes-app, noteup, react, tauri, tauri-app
- Language: TypeScript
- Homepage: https://noteup.dev/
- Size: 4.46 MB
- Stars: 30
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - GarliqBread/Noteup - Markup note-taking app (react)
README
[](https://app.netlify.com/sites/stupendous-cucurucho-1aee31/deploys)
Noteup
[Live version](https://noteup.dev/)
A Web and Desktop markup note-taking app.
[Noteup](https://noteup.dev/) is a free, open-source Github-flavored markup note-taking app for the web, mobile(PWA) and desktop. Your notes are saved in the local storage but are available for import/export.
## Get started
To get started just visit [noteup.dev](https://noteup.dev) or [download a build](https://github.com/GarliqBread/Noteup/releases) or clone the repo and run the install and start scripts
```properties
yarn install
```
```properties
yarn start
```
To run the desktop version, after installing run
```properties
yarn tauri dev
```
To make a desktop build run
```properties
yarn build
yarn tauri build
```
## Roadmap
- [x] Tandem scroll for side-by-side editing
- [x] Quick command bar (WYSIWYG style)
- [x] Add a landing page to the website
- [x] Extra download options (like `.pdf`)
- [ ] Add a page with markdown help commands
- [ ] Note sharing
- [ ] Account sync
- [ ] Cross-platform sync
## Contributing
This is an open-source project, and contributions are welcomed and appreciated. Open issues, bugs, and enhancements are all listed on the [issues](https://github.com/GarliqBread/noteup/issues) tab and labeled accordingly.
View [CONTRIBUTING.md](CONTRIBUTING.md) to learn about the style guide, folder structure, scripts, and how to contribute.
## Inspirations
This project was visually inspired by another markdown note app called [Takenote](https://github.com/taniarascia/takenote) and the macOS notes app.
## Contributors ✨
Thanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
## Author
- [Cláudio](https://github.com/GarliqBread)
## License
This project is open source and available under the [MIT License](LICENSE).
