Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Aglio backend for Foliant documentation generator.

Project description

Aglio Backend for Foliant

Aglio backend generates API documentation from API Blueprint using aglio renderer.

This backend operates the site target.

Note, that aglio is designed to render API Blueprint documents. Blueprint syntax is very close to that of Markdown and you may be tempted to use this backend as a general purpose static site generator, which may work in some cases, but is not guaranteed to work in all of them.

Installation

$ pip install foliantcontrib.aglio

Usage

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

To test if you've installed aglio properly run the aglio -h command, which should return you a list of options.

To generate a static website from your Foliant project run the following command:

$ foliant make site --with aglio
Parsing config... Done
Making site...
Done
────────────────────
Result: My_Awesome_Project.aglio

Config

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

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

backend_config:
  aglio:
    aglio_path: aglio
    params:
        theme-variables: flatly
        fullWidth: True

aglio_path : Path to the aglio binary. Default: aglio

params : Parameters which will be supplied to the aglio command. To get the list of possible parameters, run aglio -h or check the official docs.

Customizing output

Templates

You can customize the appearence of the static website build by aglio with Jade templates. Aglio has two built-in templates:

  • default — two-column web-page;
  • triple — three-column web-page.

To add your own template, follow the instructions in the official docs.

To specify the template add the theme-template field to the params option:

backend_config:
  aglio:
    params:
        theme-template: triple

Color scheme

You can customize the color scheme of the website by specifying the color scheme name in theme-variables param.

Available built-in color schemes:

  • default,
  • cyborg,
  • flatly,
  • slate,
  • streak.

You can also specify your own scheme in a LESS or CSS file.

backend_config:
  aglio:
    params:
        theme-variables: flatly

Stylesheets

Finally, you can provide custom stylesheets in a LESS or CSS file in theme-style param:

backend_config:
  aglio:
    params:
        theme-style: !path my-style.less

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for foliantcontrib.aglio, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size foliantcontrib.aglio-1.0.0-py3-none-any.whl (5.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size foliantcontrib.aglio-1.0.0.tar.gz (4.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page