php-pure/themer

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

A markdown based documentation

dev-master / 0.1.x-dev 2016-09-27 01:48 UTC

This package is auto-updated.

Last update: 2021-11-15 00:38:40 UTC


README

A template, the converts markdown .md files into well static html page, depending on the theme you will use.

Index

The Factory

We have a factory that handles combines all the processes and calls the themes you need.

$map

Just a map for our markdowns.

$map = [
    'Prologue' => [
        'Setup' => __DIR__.'/docs/prologue/setup.md',
        'Change Log' => __DIR__.'/docs/prologue/change_log.md',
    ],
];

$view_variables

You can freely pass a variable in the factory. Please take a note that this variables will be over-written/added a new variable when you will be using a different theme.

$view_variables = [
    'uri' => 'http://example.com',
    'title' => 'My Documentation',
    // and so on ...
];

Finally to call the factory, Please take a note that the below code is still incomplete, that we still need to review how the theme works.

<?php

$map = [...];
$view_variables = [...];

$factory = new PhpPure\Themer\Factory($map, $theme_variables, $view_variables);

Themes

We're using Laravel's Blade Component to handle the views.

PHP Pure has a theme that we could use for documentation, and that is the basic template that we added in the core.

$basic = new PhpPure\Themer\Themes\Basic\Basic;
$basic->setViewsDir(__DIR__.'/views');
$basic->setCacheDir(__DIR__.'/views/.cache');

The above code, we instantiated the Basic class, we set the views folder, and also the cache folder.

The Basic Theme requires us to inject a theme variables in the factory, we must inject the extension and landing_page.

$theme_variables = [
    'extension' => 'html',
    'landing_page' => $map['Prologue']['Setup'],
];

To finalize the factory, check code below.

...

$factory->theme($basic);
$factory->generate('public/'); // the folder to generate with

Test

We have a sample tests that your could try out or mimic.

Writing your own Theme

I can't write everything here, so maybe let's move on to our wiki.