Welcome! → Nanoki
 
 

Nanoki

Last modified on Wednesday, November 25th 2009 at 5:06 PM.

Nanoki is a simple wiki engine implemented in Lua, allowing you to create, edit, and link web pages easily.

Nanoki


Run Nanoki

Start Nanoki from the command line:

cd Nanoki
lua Nanoki.lua . localhost 1080

The above command will start Nanoki on your local host at port 1080, using the local directory for storage:

http://localhost:1080/

Command synopsis:

Nanoki [location] [address] [port] [not|forwarded] [not|secure]

location tells Nanoki where to store its data.
address indicates which network address to bind the Nanoki server to.
port indicates what port number to use.
forwarded indicates whether x-forwarded-for should be trusted.
secure indicates whether https should be used.

Run


Create a page

To create a new page, type its name in your browser address bar:

New

If the page doesn't exists yet, Nanoki will redirect you to the page editor:

New Editor


Edit a page

To edit a page, click on its title. This will take you to the page editor:

Editor

The editor uses Markdown syntax to describe the page content.

To save your text, press Preview and then Save.


Upload a file

From the editor, you can upload files to Nanoki:

File

Each page can have its own files. You can refer to those files like so:

![Run][1]
[1]: nanoki/file/run.png

File link synopsis:

[page]/file/[name]

page is the name of the page under which the file is located.
name is the file name.


Control panel

From the editor, you can access the control panel to rename or delete a page:

Control


Revision

From the editor, you can access a page revision history by clicking on its title:

Revision

Clicking a revision number will display the page content as it was then.


Revision differences

From the revision page, you can access the revision differences by clicking on its title:

Revision differences


Related pages

Each page keep tracks of which other pages links to it:

Related


Breadcrumb navigation

Each page reflects its location using a breadcrumb trail:

Breadcrumb


Index navigation

Nanoki provides a table of content, indexed by page title:

Index


Date navigation

The date navigation indexes pages by their publication date:

Date


Recent changes

The recent changes page lists what has changed in Nanoki recently:

Recent


Search

The search allows to locate pages by their title:

Search


XML feed

Aside from the editor, most pages provide an XML feed:

Feed

Feed view


System page

The system page provides basic information about Nanoki itself:

System