Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Awesome Lists containing this project

README

        

[![Netlify Status](https://api.netlify.com/api/v1/badges/c07f2af9-ca82-4f2e-a051-3de8e232cebe/deploy-status)](https://app.netlify.com/sites/stupendous-cucurucho-1aee31/deploys)



Noteup

[Live version](https://noteup.dev/)

A Web and Desktop markup note-taking app.

![Screenshot](./assets/mockups.png)

[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)):




Cláudio Silva

💻 📖 🚧

## Author

- [Cláudio](https://github.com/GarliqBread)

## License

This project is open source and available under the [MIT License](LICENSE).