Note Mark

<img src="frontend/public/icon.svg" width=200 height=200>

# Note Mark
![License: AGPL V3](https://img.shields.io/github/license/enchant97/note-mark?style=flat-square)
![GitHub Latest Release](https://img.shields.io/github/v/release/enchant97/note-mark?include_prereleases&label=latest%20release&style=flat-square)

Note Mark is a lighting fast and minimal; web-based Markdown notes app. Featuring a sleek and responsive web UI.

> [!IMPORTANT]
> Working on V1, V0.19 will implement a migrate/export utility and project will be maintenance only until release of V1.
> Stay tuned!

## Features
- Markdown (GitHub Flavored Markdown, see spec [here](https://github.github.com/gfm/))
- HTML sanitisation, minimizing XSS attacks
- Mobile Friendly
- Friendly URLs for cleaner links
- Dark & Light Theme
- Notebook Sharing
- Custom flat-file based storage system
- Multiple views for a note (rendered, plain)
- Lighting fast editor with shortcuts
- Upload and attach assets
- OIDC support for Single-Sign-On

## Showcase
![Preview Image Showing App](site/static/preview.webp)

## Demo Video
[![Demo Video](https://img.youtube.com/vi/rwL99Ac5g98/0.jpg)](https://youtu.be/rwL99Ac5g98 "Demo Video")

<https://youtu.be/rwL99Ac5g98>

## Docs
Documentation is available here: [notemark.docs.enchantedcode.co.uk](https://notemark.docs.enchantedcode.co.uk/).

> Checkout the [roadmap here](https://github.com/users/enchant97/projects/7).

## Support Me
Like this project? Consider supporting me financially so I can continue development.

<a href="https://www.buymeacoffee.com/leospratt" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-blue.png" alt="Buy Me A Coffee" height=60></a>

> Please note I currently do not accept paid incentives for features.

## License
This project is Copyright (c) 2024 Leo Spratt, licences shown below:

Code

    AGPL-3.0. Full license found in `LICENSE.txt`

Icon / Mark

    All Rights Reserved