Self-hostable web app for markdown note-taking, written in Golang and utilizing HTMX. Notes are stored in plain markdown files. Multiple user support via SQLite.
This project was heavily inspired by another excellent note taking application, Flatnotes. It is very much a work in progress and lacks many features such as image support and the ability to rename notes.
Landing page for browsing your notes. Hovering over a note title in the list shows a preview to the right. Quick actions (delete, fullscreen, edit) also appear next to the note title. Search bar allows searching for a note by title.
No frills markdown editor. Write on the left, preview on the right. Thats it.
Larger view of the rendered note.
Papernotes can be run as a Docker container via docker-compose:
# docker-compose.yml
---
version: "3"
services:
papernote:
image: noahhefner/papernote:latest
container_name: papernote
volumes:
- /path/to/data:/data
ports:
- 8080:80
user: 1000:1000
environment:
JWT_SECRET: ${JWT_SECRET}# .env
JWT_SECRET=SUPER_SECRET_SECRETThe /data directory will be structured as follows:
/data
├── db
│ └── users.db
└── notes
├── user
│ ├── cron-notes.md
│ ├── lorum-ipsum.md
│ └── yellowstone.md
└── user2
├── user2-note1.md
└── user2-note2.md
Dependencies:
The test-data directory provides a sample database and user directory with a few notes for testing purposes. .air.toml sets the DATA_DIR environment variable to ./test-data for convenience. Note and database changes will be reflected in this directory. /test-data is in the .gitignore, so changes made while testing will not be committed to the remote.
Test user and password:
- Username:
user - Password:
pass
Run the air server and access the application at localhost:8080:
air
Helper commands for working with Docker are provided via Makefile.
| Command | Action |
|---|---|
make build |
Create Docker container |
make run |
Run temporary Docker container |
make clean |
Delete Docker container |
make publish |
Publish Docker container to Docker Hub |