DocumentationTo see a map of the documentation area: documentation sitemap.
- Extract your archive to some directory (or clone the repo, or whatever). This should be inside your document root, as the style/ directory needs to be web-visible.
- If you downloaded a development version from GitHub (as opposed to an archive from this site), remove the tests/ directory, this is not something you want to expose on a public machine.
- Create a directory called 'cache' inside your luminous directory and make sure it is writeable to your server (this probably involves 777 permissions).
- Now test everything is working by creating a new file, the hello world of highlighting:
<?php require_once '/path/to/luminous/luminous.php'; echo luminous::head_html(); // outputs CSS includes, intended to go in <head> echo luminous::highlight('c', 'printf("hello world\n");');
- Point your browser at the page you just created and it should show a single line of highlighted source code.
Problems?Check out the troubleshooting guide.
- Consult the cache page to use an SQL table as your cache, or learn more about the cache's behaviour.
- Check the examples/ directory for a few examples of how you might use Luminous
- Have a look at the User API Reference for setting up runtime configuration settings.
HackingIf you want to change how Luminous works or add new features, check out the hacking section.
If you want to contribute but are stuck for ideas (hint hint), check out the todo page.
Local API DocsThe packaged distros come with Doxygen API documentation in the docs/html/ directory.
These documents are intended to be a class/method specification. The documentation on this site is supposed to be a little more high level and it is not exhaustive; if you find it insufficient the Doxygen pages should provide more detail. It covers both the public callers' API and the internal scanning API.
A copy of these is held online for a recent development/git version (which might not be the same as your version).