Browse Source

Updated readme

3.0
Ubergeek 2 years ago
parent
commit
e56878e11d
  1. 50
      README.md

50
README.md

@ -1,49 +1,7 @@
Wiki.php
========
# Thunix Website Code
Wiki.php is a simple cms/wiki script. You can see it in use here:
This is the code powering the thunix website. It is based on [wiki.php](https://tildegit.org/ubergeek/wiki.php).
* [Thunix Wiki](https://wiki.thunix.net)
* [Ubergeek's Personal Page](https://thunix.net/~ubergeek)
Installation
============
Installation is really only a couple of steps:
* Clone down the repo
* Edit config.php. The values are pretty self-explantory, but there's also comments explaining
* Edit includes/header.md, includes/footer.md, and includes/sidebar.md
If you are not using apache, you'll need to add in some mechanism for the rewrites to work, unless you don't care about pretty URLs. But, you will need to keep those in mind when adding links to your documents.
Something along these lines ~should~ work:
location / {
# This is cool because no php is touched for static content.
# include the "?$args" part so non-default permalinks doesn't break when using query string
try_files $uri $uri/ /wiki.php?page=$uri;
}
Once that's all set, you can start editing articles. Main.md is always the landing page.
Directory Structure
===================
./ <-- Doc root
./wiki.php <-- main code
./media <-- Images and such. Files here do get get hit by the rewrite rule
./articles <-- All of your site's content
./includes <-- Support files that make up the layout
header.md <-- site header
footer.md <-- site footer
sidebar.mb <-- site sidebar
./config.php <-- Site configuration file
./parsedown-{version} <-- The parsedown version used in this engine
Support
=======
Open an issue at [ubergeek/wiki.php](https://tildegit.org/ubergeek/wiki.php/issues). PRs are also welcomed!
Content is licensed under the Creative Commons, Share Alike, Attribution Licence.
Code is licensed under the AGPL 3 or later.
Loading…
Cancel
Save