https://github.com/alexanderjulo/wiki

a flask based wiki, using markdown files as backend. completely file based!
https://github.com/alexanderjulo/wiki

Last synced: 9 days ago
JSON representation

a flask based wiki, using markdown files as backend. completely file based!

• Host: GitHub
• URL: https://github.com/alexanderjulo/wiki
• Owner: alexanderjulo
• License: bsd-3-clause
• Created: 2012-10-11T07:53:30.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2021-03-22T18:47:49.000Z (over 3 years ago)
• Last Synced: 2024-03-15T01:03:39.277Z (9 months ago)
• Language: Python
• Homepage:
• Size: 873 KB
• Stars: 281
• Watchers: 20
• Forks: 87
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - alexanderjulo/wiki - a flask based wiki, using markdown files as backend. completely file based! (Python)

README

        
# Readme

[![Linux build status](https://travis-ci.org/alexanderjulo/wiki.svg?branch=master)](https://travis-ci.org/alexanderjulo/wiki)

[![Windows build status](https://ci.appveyor.com/api/projects/status/ysdxr7rssv6v0j6o/branch/master?svg=true)](https://ci.appveyor.com/project/alexanderjulo/wiki/branch/master)

[![Join the chat at https://gitter.im/gitterHQ/gitterHQ.github.io](https://badges.gitter.im/gitterHQ/gitterHQ.github.io.svg)](https://gitter.im/wiki/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## About

As I wanted a wiki that just uses plain markdown files as backend, that is easy

to use and that is written in python, to enable me to easily hack around,

but found nothing, I just wrote this down. I hope that it might help others ,too.

## Features

* Markdown Syntax Editing

* Tags

* Regex Search

* Random URLs

* Web Editor

* Pages can also be edited manually, possible uses are:

	* use the cli

	* use your favorite editor

	* sync with dropbox

	* and many more

### Planned

* Re-introduce support for customizing the theme

* Speed Improvements

	* Code Optimizations

	* Caching

* Settings via the webinterface

## Setup

You can install wiki using:

	pip install wiki2

Afterwards you can create or change into your content directory and create a `config.py` file in it, that contains at least the following:

	# encoding: