Giter Club home page Giter Club logo

flask-wiki's Introduction

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

flask-wiki's People

Contributors

pascalrepond avatar jma avatar rerowep avatar williamnt avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.