CakePHP 3, Bootstrap Helpers Documentation

This branch of the repository contains the source file for the documentation at https://holt59.github.io/cakephp3-bootstrap-helpers/.

How to contribute?

The documentation is written using mkdocs. In order to use mkdocs, you need to install python (python 3+ preferred). You then need to install mkdocs:

$ pip install mkdocs

You are now ready to work with the documentation:

$ git clone --branch https://github.com/Holt59/cakephp3-bootstrap-helpers.git
$ export PYTHONPATH=${PYTHONPATH}:$(pwd)
$ mkdocs serve

The mkdocs serve command will start a local webserver on port 8000 so that you can see the changes you made without having to build the documentation.

You need to add the current directory to your PYTHONPATH environment variables so that python can found the custom markdown extensions in the mkexts folder.

See the mkdocs documentation for more information.

Custom Markdown extensions

The source code highlighter used for the documentation is prism.js, the prism markdown extension is a small extension that will generated appropriate classes for the code block.

The tabs markdown extension is more complex and allows you to create bootstrap tabs:

-- TABS: name-of-the-block

-- TAB: first-tab

Some tab content...

-- TAB: second-tab

Some tab content for the second tab...

-- TABS

Copyright and license

The MIT License (MIT)

Copyright (c) 2017, Mikaël Capelle.

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.

See LICENSE.