Skip to content
Simple little wiki used to expose a web interface between different text files.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
error
script
style
.gitignore
LICENSE
README.md
config.json
index.html
launch-chrome-wiki.bat
launch-chrome-wiki.sh

README.md

localwiki

goal

The goal of this project is to allow someone to create a local documentation system without a server. It is most useful inside of a revision control system and the files should be editable with a text editor due to the syntax.

syntax

The wiki uses markdown syntax and local AJAX calls in order to chain together a locally working, minimally invasive wiki system.

configuration

In order to change the configuration for this wiki, take a look at the example config.json file provided with the source. If you want to store your configuration file outside of the localwiki home directory, change the data-config-url attribute to a different URL in the index.html.

notes

google chrome

Unforunately, Google Chrome does not by default allow local AJAX requests to take place from the filesystem. This is an understandable security decision. If you want to view pages stored on localwiki without using a server, launch Google Chrome using one of the launching scripts provided. These scripts have been tested in Windows 7 and Ubuntu Linux.

firefox

Firefox allows the above, but does not allow you to go higher in the filesystem than the current directory. That means your wiki's base directory should be above the directory containing the index.html.

links

  1. github
  2. license
You can’t perform that action at this time.