TinyWiki
Folder structure-based PHP wiki documentation engine
This is a super simple PHP folder structure based wiki engine
for creating code documentation webpages with support for Markdown Language
using Parsedown or alternatively it's own Work-in-Progress Markup language (.tinyw),
and also features an implementation of Highlight.js for syntax highlighting.
Setting up
- Download the latest release, or alternatively if you want to be on the bleeding-edge with the latest features, you may download the repository directly and remove the unecessary files, but be aware that bugs should be expected outside of releases.
- After downloading the archive, extract it's contents into any (empty) directory of your website / webserver.
- Opening the webpage for the first time should come up with a configuration prompt. (Alternatively you can change the configs manually)
Running Dependencies
- PHP >= 5.3.0
using .tinyw file
tinyw is a work-in-progress simple markup language, it aims to provide a simple standardized way to write code documentation.
Syntax:
// cpp code *bold text* _italic text_ _*bold and italic*_
underline text
strikethrough text
link text
">
# comment
-- lua code
// cpp code
*bold text*
_italic text_
_*bold and italic*_
underline text
strikethrough text
link text
Permissions:
By default you don't really need to modify the permissions on your server, but if you do want that, the ones you are free to hide from the web are: bin/
/docs/