themsaid/katana

A neat static site & blog generator with markdown support.

Katana static site & blog generator

, _(*1)

PHP static site & blog generator with markdown support., _(*2)

Using the power of laravel's Blade templating engine., _(*3)

, _(*4)

Katana was inspired by Jigsaw by Adam Wathan and the folks at Tighten., _(*5)

Requirements

• PHP 5.5.9+ or newer
• Apache or Nginx server
• Composer

Installation

To install a fresh Katana installation you need to install composer & run the following command:, _(*6)

composer create-project themsaid/katana my-new-site

Once the installation is done you may build your website using the command:, _(*7)

php katana build

Katana is shipped with sample content to help you get started immediately, and after this command runs your site will be generated in the /public directory., _(*8)

Documentation

The complete Katana documentation can be found here: http://themsaid.github.io/katana/, _(*9)

Blog generator

Katana is shipped with a static blog generator, all you need to do is create a new .blade.php file in the /content/_blog directory and Katana will compile all the posts and present them in a view of your choice., _(*10)

Blog posts list is paginated based on the configuration options in config.php. There's also a $blogPosts variable available in all your blade views that contains an array of posts., _(*11)

Blade templating engine

Blade is a simple yet powerful templating engine built for laravel, you need to check Blade's documentation if you're not already familiar with it., _(*12)

Using with GitHub Pages

You can use Katana to publish a website over GitHub Pages using subtrees, the idea is to deploy the public directory as the master branch of your user GitHub pages repository or the gh-pages branch of your project repository., _(*13)

You can find the full details in the documentation., _(*14)

Contribution

Contributions are welcomed in this repository https://github.com/themsaid/katana-core where all source files exist., _(*15)