2021-02-23 22:54:08 +01:00
|
|
|
# Salvi
|
|
|
|
|
|
|
|
|
|
Salvi is a simple wiki-like note-taking web application, written in Python using
|
|
|
|
|
Flask framework.
|
|
|
|
|
|
|
|
|
|
**Warning**: Salvi is designed for personal, individual use. It may not be
|
|
|
|
|
suitable as a community or team knowledge base.
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
+ Write notes on the go, using Markdown syntax
|
|
|
|
|
+ Any note can have its own URL
|
|
|
|
|
+ Revision history
|
2022-06-12 11:10:41 +02:00
|
|
|
+ Stored in SQLite/MySQL databases
|
2021-02-23 22:54:08 +01:00
|
|
|
+ Material Icons
|
2021-02-23 23:54:29 +01:00
|
|
|
+ Light/dark theme
|
2021-02-23 22:54:08 +01:00
|
|
|
+ Works fine even with JavaScript disabled.
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
+ **Python** 3.6+.
|
2022-06-12 11:10:41 +02:00
|
|
|
+ **Flask** web framework (and Flask-Login / Flask-WTF extensions).
|
2021-02-23 22:54:08 +01:00
|
|
|
+ **Peewee** ORM.
|
2022-11-09 14:56:41 +01:00
|
|
|
+ **Markdown** for page rendering.
|
|
|
|
|
+ **Python-I18n**.
|
2021-02-23 22:54:08 +01:00
|
|
|
|
2022-06-12 11:10:41 +02:00
|
|
|
### Optional requirements
|
|
|
|
|
|
|
|
|
|
* **Markdown-KaTeX** if you want to display math inside pages.
|
|
|
|
|
|
2021-02-23 22:54:08 +01:00
|
|
|
## Caveats
|
|
|
|
|
|
|
|
|
|
+ All pages created are, as of now, viewable and editable by anyone, with no
|
|
|
|
|
trace of users and/or passwords.
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
[MIT License](./LICENSE).
|
