Arya's documentation
What is this?
This is the default page for arya, yet another content management system in PHP, which tries to avoid the use of databases.
Features
- markdown syntax
- everything is a file
- manages several kinds of resources (images, text, ...)
- blog module
- i18n
Installation and configuration
You need a webserver with PHP configured. Currently only apache 2 is properly supported, if someone wants to write rewriting rules for other web servers, he's welcome. You also need to know some bits of PHP to properly configure arya. Assuming arya was downloaded in /tmp, its installation is fairly simple:
$ cd /path/to/web/directory $ tar -xf /tmp/arya.tar.gz . $ $EDITOR arya/config.php
The file config.php is itself commented, and requires little modification. From there you can add new css files, enable or disable modules, change headlines and menus, ... Don't forget the .htaccess file, for sources of arya do not need to be accessed from the outside (basically it prevents anyone to browse the folder arya, content and blog). Only index.php needs to be accessed.
Layout
You may need to modify the layout, which resides in arya/layout.html.
Available modules
arya is shipped with three modules that are enabled by default:
- content, a module to manage different kind of contents (articles, images, ...), this is the one in used on this page.
- blog, a module to post articles.
- 404, a module to handle inexistant pages.
Content module
This module has a root directory, by default the content/ directory at the root of your web directory. You can simply create new files or directory in it to see it online. Currently, the following extensions are supported :
- md, for a markdown file, like this one. The markdown version used by arya also support a [TOC] keyword to place a table of content.
- jpg,gif,png for images
- txt for plain text files
If you need content in different languages, you can add to the extension the language of the ressource (ie: index.md.fr for content in french). In that case, the lang of index.md will be the default one (as defined in arya/config.php).
Blog module
This module also has a root directory, by default blog/. Its usage is quite basic, as you only need to create new markdown files. The unix timestamp of the file is used to date the article. You can modify the layout of articles by editing the file arya/mods/blog/blog.html and arya/mods/blog/index.html.
Concerning articles in different languages, this module behaves like the content module.
404 module
Module called to handle a 404 error, you can modify the layout by editing arya/mods/404/404.html.