luminos

README

Luminos, markdown server

Luminos is a tiny HTTP/FastCGI server written in Go that converts markdown files into HTML on the fly.

Getting Luminos

In order to download and install Luminos, a working Go environment is required.

If you already have Go, you may install Luminos by issuing the following command:

go get github.com/lnxjedi/luminos

Usage

rev@localhost > luminos

Luminos Markdown Server (v0.9.2-snapshot) - https://github.com/lnxjedi/luminos
by J. Carlos Nieto / David Parsley

Usage: luminos <arguments> <command>

Available commands for luminos:

        help            Shows information about the given command.
        index           Generates Index(es) for Luminos sites
        run             Runs a luminos server.
        version         Prints software version.

Use "luminos help <command>" to view more information about a command.

You can start by copying the example site in the _example directory to e.g. test-site, then you can ask luminos run to serve it:

cd test-site
luminos run

If you want to use Luminos with Apache or NGINX see the Getting started page.

Documentation

See the project's page for documentation, tips and tricks.

Licenses and acknowledgements

Luminos is released under the MIT License.

Copyright (c) 2012-2013 José Carlos Nieto, https://github.com/lnxjedi/luminos

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The Hyde theme was created by Mark Otto for Jekyll and released under the MIT License.

Copyright (c) 2013 Mark Otto.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.