Simple file-based wiki for Flask
Project description
Flask-Wiki
About
Simple file based wiki for Flask.
Getting started
Requirements
- Python >=3.9.2,<3.13
- uv
Install dev environment
- Clone the git repository
- run
uv sync --frozen cd examplesuv run flask flask_wiki init-indexuv run flask flask_wiki index- then
uv run flask run --debug - go to http://localhost:5000/help
Configuration
Templates
- WIKI_BASE_TEMPLATE = 'wiki/base.html'
- WIKI_SEARCH_TEMPLATE = 'wiki/search.html'
- WIKI_NOT_FOUND_TEMPLATE = 'wiki/404.html'
- WIKI_FORBIDDEN_TEMPLATE = 'wiki/403.html'
- WIKI_EDITOR_TEMPLATE = 'wiki/editor.html'
- WIKI_FILES_TEMPLATE = 'wiki/files.html'
- WIKI_PAGE_TEMPLATE = 'wiki/page.html'
Miscs
- WIKI_HOME = 'home'
- WIKI_CURRENT_LANGUAGE = lambda: 'en'
- WIKI_LANGUAGES = {'en': 'English', 'fr': 'French', 'de': 'German', 'it': 'Italian'}
- WIKI_URL_PREFIX = '/help'
- WIKI_CONTENT_DIR = './data'
- WIKI_INDEX_DIR = './index'
- WIKI_UPLOAD_FOLDER = os.path.join(WIKI_CONTENT_DIR, 'files')
- WIKI_ALLOWED_EXTENSIONS = {'png', 'jpg', 'jpeg', 'gif', 'svg'}
- WIKI_MARKDOWN_EXTENSIONS = set(('codehilite', 'fenced_code'))
Permissions
- WIKI_EDIT_VIEW_PERMISSION = lambda: True
- WIKI_READ_VIEW_PERMISSION = lambda: True
- WIKI_EDIT_UI_PERMISSION = WIKI_EDIT_VIEW_PERMISSION
- WIKI_READ_UI_PERMISSION = WIKI_READ_VIEW_PERMISSION
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
flask_wiki-1.0.4.tar.gz
(691.1 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
flask_wiki-1.0.4-py3-none-any.whl
(719.0 kB
view details)
File details
Details for the file flask_wiki-1.0.4.tar.gz.
File metadata
- Download URL: flask_wiki-1.0.4.tar.gz
- Upload date:
- Size: 691.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8ee3a78a3ad54c5889a18404f148702e568212095f66d6db1e8212916df22883
|
|
| MD5 |
c3e01eb504e9d2e0191e0be27f67e473
|
|
| BLAKE2b-256 |
b79024b4d1218ac43a29cd1c7026b6e61b35235084ef7f3e243af6165591a987
|
File details
Details for the file flask_wiki-1.0.4-py3-none-any.whl.
File metadata
- Download URL: flask_wiki-1.0.4-py3-none-any.whl
- Upload date:
- Size: 719.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c1d5aec7a0cc22a27e855a6d7d4bc063825ed7d0241d8ed73bdd1383d920132c
|
|
| MD5 |
fd216428cffab62930c9195d5509d8b0
|
|
| BLAKE2b-256 |
ccafd43b735534e0c6efcaa3624773ae70cb04b73195be48a3afb4b78f0c29c1
|
