Documentation

Learn to dance with the Banana!

Pages

Naming Conventions

It's recommended that you only use alpha-numeric characters, as well as underscores in page names.

Creating Pages

To create pages, simply add new files anywhere within the "wiki/en" folder. Make sure the files have the ".md" extension.

Re-naming Pages

By default, the program will clean file names in the following fashion:

  • "Quick_Start_Guide.md" becomes "Quick Start Guide"
  • "Some_other_page.md" becomes "Some other page"

Notice how the program will not change the character case, but will replace underscores with spaces.

Customizing Page Names Further

You can customize page names further by editing the "wiki/config/structure_name.php" file. The array looks like this:

return array(
    'en' => array(
        'index.md' => 'Installation',
    ),
    'fr' => array(
        'index.md' => 'Bienvenue',
    ),
);

To customize the file name, include the path to the file. Example:

return array(
    'en' => array(
        'index.md' => 'Installation',
        'my_category/index.md' => 'My Category Homepage',
    ),
    'fr' => array(
        'index.md' => 'Bienvenue',
        'my_category/index.md' => 'Bienvenue a Mon Categorie',
    ),
);

Notice how the program allows you to customize page names in multiple languages. Simply create a nested array with the two letter language code as the key, and then create your custom names within that language array. Click here for more information on languages.

Re-ordering Pages

The program doesn't always order pages as you might expect. If you need to re-order pages, edit the "wiki/config/structure_order.php" file by addibf pages in the order you want them to appear:

return array(
    'index.md',
    'Quick_Start_Guide.md',
    'Build',
    'Build/Pages.md',
    'Build/Categories.md',
    'Build/Languages.md',
);

You can sort folders as well by placing the name of the folder in the array, for example "Build" above.

Hiding a Page

Add a period "." to the start of any page or folder to hide it. Example "Pages.md" becomes ".Pages.md".

Adding Columns

The program integrates Bootstrap's grid system for column generation. An example of a two-column page with markdown support would be:

<div class="container-fluid">
    <div class="row">
        <div class="col-sm-6" markdown="1">
Your markdown here...
        </div>
        <div class="col-sm-6" markdown="1">
Your markdown here...
        </div>
    </div>
</div>

Notice the markdown="1": this is required to render markdown within the columns.

Last modified 1 year ago.