Simple file-based wiki for Flask
Project description
Flask-Wiki
About
Simple file based wiki for Flask.
Getting started
Requirements
- Python >=3.6.2
- Poetry
Install
- Clone the git repository
- run
poetry install
- If you want to enable debug mode, run
export FLASK_ENV=development
cd examples
, thenpoetry run flask run
- go to http://localhost:5000/wiki
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']
- WIKI_URL_PREFIX = '/wiki'
- WIKI_CONTENT_DIR = './data'
- 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.2.3.tar.gz
(690.2 kB
view hashes)
Built Distribution
flask_wiki-0.2.3-py3-none-any.whl
(714.8 kB
view hashes)
Close
Hashes for flask_wiki-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d708ba00156a17aa1d05c351445ef9aec3961a4d781956b13e381b163a260672 |
|
MD5 | bfc886e65ea9b27972aac61f99710638 |
|
BLAKE2b-256 | fb07c996d408463855948dfdc6915669aa7e800252e363b53a362c2cefd0eae3 |