https://github.com/brejoc/mercurial-wiki

Mercurial Wiki is a wiki with the sole purpose to be embedded into a Mercurial repository. Everyone who clones the repository will automatically get the wiki documentation with all the information needed to get started or the latest changes for the project or branch. Regardless if you are sitting in a plane or travel in nature without internet connection, all the important information are stored right in the repository just with the code.
https://github.com/brejoc/mercurial-wiki

mercurial wiki wiki-documentation

Last synced: about 2 months ago
JSON representation

Mercurial Wiki is a wiki with the sole purpose to be embedded into a Mercurial repository. Everyone who clones the repository will automatically get the wiki documentation with all the information needed to get started or the latest changes for the project or branch. Regardless if you are sitting in a plane or travel in nature without internet connection, all the important information are stored right in the repository just with the code.

• Host: GitHub
• URL: https://github.com/brejoc/mercurial-wiki
• Owner: brejoc
• Created: 2015-07-04T19:43:53.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-12T21:16:57.000Z (almost 8 years ago)
• Last Synced: 2023-06-28T12:53:13.032Z (over 1 year ago)
• Topics: mercurial, wiki, wiki-documentation
• Language: Python
• Size: 428 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ATTENTION

**This project is abandoned. If someone is interested in maintaining it, please contact me.**

## Mercurial Wiki

Mercurial Wiki is a wiki with the sole purpose to be embedded into a Mercurial repository. Everyone who clones the repository will automatically get the wiki documentation with all the information needed to get started or the latest changes for the project or branch. 

Regardless if you are sitting in a plane or travel in nature without internet connection, all the important information are stored right in the repository just with the code.

The [Markdown](https://pypi.python.org/pypi/markdown2/) markup is used to format and layout the wiki pages. Up until version 1.2 [creole markup](http://en.wikipedia.org/wiki/Creole_(markup)) was used.

### Dependencies 

Mercurial Wiki requires bottle.py, Jinja2, markdown2 and of course Mercurial. You can install the dependencies with `pip install -r requirements.txt`. But you should create a virtualenv first: `virtualenv --distribute --no-site-packages env`. And don't forget to activate it with `. env/bin/activate`.

### Usage

Download Mercurial Wiki und extract anywhere. Now cd to your ~/bin or /usr/local/bin folder and create a symlink (ln -s  hgwiki) to the hgwiki.py. Now you can change to a local Mercurial repository (only base path works for now) and enter hgwiki. A browser window opens and shows the start page.

### Installation for Ubuntu 12.04 Precise 

A ready to install [package for Ubuntu 12.04](https://bitbucket.org/brejoc/mercurial-wiki/downloads/python-mercurial-wiki_0.1~hg20130319-precise1_all.deb) Precise can be found in [Downloads](https://bitbucket.org/brejoc/mercurial-wiki/downloads).

The [fpm makefile](https://bitbucket.org/brejoc/fpm-makefiles/src/tip/ubuntu/12.04/hgwiki/Makefile?at=default) for this package can be found in my [fpm makefiles repository](https://bitbucket.org/brejoc/fpm-makefiles).