Repository navigation
v0.2.0
First tagged release of notefeed.
-
Post markdown notes over HTTP (
POST /api/notes, bearer token) or in the web UI; read them back as RSS at/feed.xml. -
Every note is a plain
.mdfile. With the./databind mount the files belong to you, so you can grep them or keep them in git. -
Client packages for Python (
pip install notefeed) and Node (npm install notefeed), each with anotefeed postcommand. -
Documentation: https://marceltov.github.io/notefeed/
-
The URL and token are set once, when you create the
Client. The libraries no longer readNOTEFEED_URL/NOTEFEED_TOKEN; only thenotefeedcommand does. -
The top-level
post()helper was removed. UseClient(...).post(markdown).
What's Changed
- notefeed: markdown notes in, RSS out by @Marceltov in #1
- Docs site, login redirect fix, curl hint, dev script by @Marceltov in #2
- Client packages on PyPI and npm, tagged releases by @Marceltov in #3
- Release 0.2.0: version bump and web UI screenshot by @Marceltov in #4
Full Changelog: https://github.com/Marceltov/notefeed/commits/v0.2.0
Install
# compose.yaml
services:
notefeed:
image: ghcr.io/marceltov/notefeed:0.2.0
restart: unless-stopped
ports:
- "3000:3000"
environment:
NOTEFEED_TOKEN: ${NOTEFEED_TOKEN:?Set NOTEFEED_TOKEN in .env}
# PUBLIC_URL: https://notes.example.com
# TZ: Europe/Berlin
volumes:
- ./data:/datamkdir data # notes are written as the owner of this folder
echo "NOTEFEED_TOKEN=$(openssl rand -hex 32)" > .env
docker compose up -dClient packages at this version: pip install notefeed==0.2.0 · npm install notefeed@0.2.0
Documentation: https://marceltov.github.io/notefeed/