Files
donniemarko/README.md
2026-02-23 13:38:30 +01:00

26 lines
946 B
Markdown

# donniemarko
Version: 0.2.0
Knowledge Management System over markdown notes.
## Release 0.1.0
- Core web UI for browsing notes
- Tagging system (add/remove, filter, search)
- SQLite-backed storage with tests
`donniemarko` works as a read-only (for now) interface over a set of markdown notes. Its goals are:
- Ensuring notes intented to be published online are correctly formatted
- Rendering the notes in a printable-friendly format, taking advantage of HTML/CSS styling
- Providing an interface to aggregate the content of those notes for quickly retrieving bits of information through searching and filtering
- Providing an interface to cross-reference those notes through a tagging system, in the same fashion as a blog or a wiki
## Development
Vendoring is supported for offline builds.
Common commands:
- `make vendor` to populate `vendor/`
- `make build` to build using vendored deps
- `make test` to run tests using vendored deps