https://github.com/h3rald/litepad
A simple notepad written in H3
https://github.com/h3rald/litepad
Last synced: 8 months ago
JSON representation
A simple notepad written in H3
- Host: GitHub
- URL: https://github.com/h3rald/litepad
- Owner: h3rald
- License: mit
- Created: 2020-05-14T20:27:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-31T17:38:50.000Z (about 5 years ago)
- Last Synced: 2025-03-30T21:39:31.736Z (10 months ago)
- Language: JavaScript
- Homepage: https://litepad.h3rald.com
- Size: 1000 KB
- Stars: 9
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LitePad
LitePad is a simple notepad application written with the [H3](https://h3.js.org) micro framework.
At present, LitePad provides:
* a way to manage notes written in Markdown.
* a way to manage code snippets.
* the possibility to search notes and snippets
* syntax highlighting for snippets written in: JavaScript, TypeScript, JSX, TSX, JSON, CSS and HTML.
* the ability to edit notes and snippets using Vim keybindings (disabled on small or touch devices).
* the possibility to copy notes/snippets to clipboard.
* the possibility to dowload snippets to their respective formats and notes to HTML with minimal styling.
* keyboard shortcuts for virtually every action and behavior (just type **h**) or click the help button in the top-right corner.
* a responsive UI, works well on desktop and small mobile devices.
## Backend
For persistence and full-text search, LitePad requires [https://h3rald.com/litestore](LiteStore), an extremely lightweight RESTful NoSQL store. It's just a single file, you can download it, place it in LitePad's project directory, and run it from command line like this:
`litestore -c:litestore.json`
This will start LiteStore on port 9300 and also serve LitePad on http://localhost:9300/dir/index.html.
Alternatively, you can also run LitePad with no backend from any web server, but in this case:
* notes and snippets will be persisted in localStorag
* a simpler (not full-text) search will be performed on note/snippets by matching search keywords with snippet and note contents.
## Demo
[https://litepad.h3rald.com](litepad.h3rald.com)
**Note:** Notes and snippets are saved to your browser's localStorage!
## License
MIT
## Credits
LitePad uses the following third-party libraries:
* [H3](https://h3.js.org) — the JavaScript framework used.
* [Primer CSS](https://primer.style/css/) — the CSS framrwork used including [Octicons](https://primer.style/octicons/).
* [Prism](https://prismjs.com/) — for syntax highlighting of snippets and code.
* [CodeMirror](https://codemirror.net/) — the editor used for both notes and snoppets.
* [Beautify](https://beautifier.io/) — for formatting HTML/JS/CSS snippets.
* [CSSLint](http://csslint.net/) — for linting CSS snippets.
* [Hotkeys](https://wangchujiang.com/hotkeys/) — for managing keyboard shortcuts.
* [Marked](https://marked.js.org/) — for rendering HTML from markdown in notes.
* [JSHint](https://jshint.com/) — for linting JavaScript snippets.
* [HTMLhint](https://htmlhint.com/) — for linting HTML snippets.
* [JSONlint](https://jsonlint.com/) — for linting JSON snippets.
* [DOMPurify](https://github.com/cure53/DOMPurify) — for sanitizing notes before rendering.