https://github.com/matthewjohn/wikode

Small wiki/note taking webapp with plain-text Git/SVN-backed storage
https://github.com/matthewjohn/wikode

git python svn wiki

Last synced: 19 days ago
JSON representation

Small wiki/note taking webapp with plain-text Git/SVN-backed storage

• Host: GitHub
• URL: https://github.com/matthewjohn/wikode
• Owner: MatthewJohn
• Created: 2024-03-30T07:08:57.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-03-30T07:37:56.000Z (8 months ago)
• Last Synced: 2024-10-12T23:13:57.526Z (about 1 month ago)
• Topics: git, python, svn, wiki
• Language: Python
• Homepage:
• Size: 352 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Wikode

Simple web-based note/documentation app, built around text-based Git/SVN storage.

Provides _some_ TracWiki (moinmoin) markup and a small amount of Markdown support.

## Example

Create a new page:

![NewNote](./docs/screenshots/NewNote.png)

![EditNote](./docs/screenshots/EditNote.png)

Published page:

![Published](./docs/screenshots/Published.png)

Search:

![Search](./docs/screenshots/Search.png)

## Install

```

virtualenv .

source bin/activate

pip install -r requirements.txt

```

## Run

```

python ./run.py

```

Goto http://localhost:5000

For alternative ports, see [Configure]

## Admin page

The admin page allows:

 * the SCM configuration to be specified,

 * re-index the local SQLite database, used for search functionality

## Configure

Create config.json in root directory, following options are available:

* LISTEN_HOST

* LISTEN_PORT

* SCM_TYPE

* DATA_DIR

* SQLITE_PATH

## Macros

There are support for some macros:

### Tags

Example:

```

[[Tags(some-tag)]]

```

Add tags to a page, which are grouped together in the 'tags' page.

## WARNING

Do not push to - this is a replica from upstream https://gitlab.dockstudios.co.uk/pub/wikode