README.md

#docstyle Welcome to docstyle basic template. The purpose of this project is to offer a simple layout to make style guides or simple documentations using markdown files.

Install

1. Download de latest version of docstyle
2. composer install
3. bower install
4. npm install

Configure

You can configure some parameters like sitename, lang, description... in public/index.php. Also you can configure your .md files routes.

$data = [

    'home' => $home,
    'lang' => 'en',
    'title' => 'docstyle',
    'description' => 'Basic template for styleguides or documentations using markdown',
    'version' => '1.0.0',
    'getting_started' => $parse->text( file_get_contents( $data_dir . '00_getting_started.md') ),

];

Add the routes in your template source/templates

[...]
<nav class="nav">
    <ul>
        <li><a href="#getting-started">Getting Started</a></li>
    </ul>
</nav>
[...]
<div id="getting-started">
    <?php echo $getting_started; ?>
</div>
[...]

Start

Add your markdow files to source/data. If you need a diferent skin, you can modify the styles in source/styles.

Gulp

Start a php server, browser-sync, watch changes on .less, .php, .md and .js:

gulp connect

Compile, minified and autoprefix styles to css:

gulp less

Minimize js:

gulp js

Generate static html from php files:

gulp static

Contributing

Please see CONTRIBUTING for details.

Creators

Segundo Fdez

• http://segundofdez.com
• https://twitter.com/segundo_fdez

Contributors

• https://github.com/segundofdez/docstyle/graphs/contributors

License

Copyright (c) 2016 Segundo Fdez (http://segundofdez.com) Code released under the the MIT license