Simple file-based wiki for Flask
Project description
Flask-Wiki
About
Simple file based wiki for Flask.
Getting started
Requirements
- Python >=3.8.0,<4.0.0
- Poetry
Install dev environment
- Clone the git repository
- run
poetry install
cd examples
,poetry run flask flask_wiki init-index
poetry run flask flask_wiki index
- then
poetry 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'))
Permssions
- 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
Project details
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-0.3.1.tar.gz
(687.6 kB
view hashes)
Built Distribution
flask_wiki-0.3.1-py3-none-any.whl
(711.8 kB
view hashes)
Close
Hashes for flask_wiki-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5710466475a7498c07a0a9e1074179bc72c21570bbafada175a59f6a3521453f |
|
MD5 | 1b7bb0d37eaf2fee06e1cb4f276709df |
|
BLAKE2b-256 | 1d532d66bcf6c91688c55ea9d81ee543740e799a2bc19c157dc17dce79ac0aaf |