foliantcontrib.slate 1.0.5

Slate backend for Foliant documentation generator.

Slate Backend for Foliant

Slate backend generates API documentation from Markdown using Slate docs generator.

This backend operates two targets:

• site — build a standalone website;
• slate — generate a slate project out from your Foliant project.

Installation

$ pip install foliantcontrib.slate

Usage

To use this backend Slate should be installed in your system. Follow the instruction in Slate repo.

To test if you've installed Slate properly head to the cloned Slate repo in your terminal and try the command below. You should get similar response.

$ bundle exec middleman
== The Middleman is loading
== View your site at ...
== Inspect your site configuration at ...

To convert Foliant project to Slate:

$ foliant make slate
✔ Parsing config
✔ Making slate
─────────────────────
Result: My_Project-2018-09-19.src/

Build a standalone website:

$ foliant make site
✔ Parsing config
✔ Making site
─────────────────────
Result: My_Project-2018-09-19.slate/

Config

You don't have to put anything in the config to use Slate backend. If it is installed, Foliant detects it.

To customize the output, use options in backend_config.slate section:

backend_config:
  slate:
    shards: data/shards
    header:
        title: My API documentation
        language_tabs:
          - xml: Response example
        search: true

shards : Path to the shards directory relative to Foliant project dir or list of such paths. Shards allow you to customize Slate's layout, add scripts etc. More info on shards in the following section. Default: shards

header : Params to be copied into the beginning of Slate main Markdown file index.html.md. They allow you to change the title of the website, toggle search and add language tabs. More info in Slate Wiki.

About shards

Shards is just a folder with files which will be copied into the generated Slate project replacing all files in there. If you follow the Slate project structure you can replace stylesheets, scripts, images, layouts etc to customize the view of the resulting site.

If shards is a string — it is considered a path to single shards directory relative to Foliant project dir:

slate:
    shards: 'data/shards'

If shards is a list — each list item is considered as a shards dir. They will be copied into the Slate project subsequently with replace.

slate:
    shards:
        - 'common/shards'
        - 'custom/shards'
        - 'new_design'

For example, I want to customize standard Slate stylesheets. I look at the Slate repo and see that they lie in the folder <slate>/source/stylesheets. I create new stylesheets with the same names as the original ones and put them into my shards dir like that:

shards\
    source\
        stylesheets\
            _variables.scss
            screen.css.scss

These stylesheets will replace the original ones in the Slate project just before the website is be baked. So the page will have my styles in the end.