Nest is a file-system driven wiki engine for PHP 5.3+.
I just wanted the ability to create a simple knowledge base in a wiki type style. I also wanted git to be able to track all of my changes.
I have no plans to make this a full fledged wiki system with access privileges or a web interface. If that is something you are looking for, then there are probably better libraries for you. Or if you are a developer, fork this repository and hack away!
The first thing you will want to do is install the library files anywhere on your system. After you clone in the repository you will want to run a recursive update to pull in linked submodules.
git submodule update --init --recursiveAfter you have all of the code you will need to link the cli script in your path somewhere.
The easiest place to link the script is in `/usr/local/bin'
cd /usr/local/bin
ln -s NEST_PATH/bin/nest.php nestIf everything goes as planned the script should be found (i.e. which nest should
print back a location).
Run nest help from the command line for a quick guide on how to use the cli script.
Adding -v to the end of a command will turn on verbose output if you would like to
see what is going on when the script is running.
You will want to navigate to the directory that you want to create your wiki in
and run nest create. This will add some default files/directories to get you
on your way.
_wiki: This directory will hold all of your "pages" in the raw format. Below is a list of supported renderers
| Renderer | Extension |
|---|---|
| PHP | .php |
| Markdown | .md, .markdown |
| Textile | .textile |
.htaccess: This file turns on url rewriting and protects some files. If your
wiki is not in the root of a site (i.e. /wiki/) you will need to change the
RewriteBase / line to reflect that (RewriteBase /wiki/).
index.php: The "controller" for the wiki. You won't have to do anything do this file.
config.ini: The configuration file. This file will need to be edited to fit your setup. Below is a list of options that can be set.
| Option | Description |
|---|---|
| system_path | A path to the nest system. This path can be absolute or relative to the config file. |
| base_url | The base url for the site. Default is "/", in our wiki example it would be "/wiki/" |
You will want to create the main layout for you site in the file _wiki/layout.php.
All of the pages that are accessed will be wrapped into this file. The only requirement
of the layout is that wherever you want your page content to show up you will need to
echo $content (<?php echo $content; ?>).
Since wiki's might not always be at the root of the site, you can use \Nest\Core::url()
and pass in a url. So with a file at css/style.css you could do \Nest\Core::url("css/style.css")
and that function will add the base_url configuration option to the beginning
of the url. This way you can specify all paths relative to the root of the site and
not have to worry about anything if your wiki gets moved.
You can also create a custom error page. Put this page in the _wiki directory
named error.EXT replacing EXT with the extension of any supported renderer.
Want to add a renderer or see some broken code? Please fork this repo and use the develop branch. When you get your feature implemented, the send those pull requests! Any pull requests that aren't applied to the develop branch won't be applied.
Developed by Dave Widmer.