Documentation GeneratorIncluding Assets

You might want to serve certain assets alongside your LucyBot documentation, such as image files for your logo and favicon, or an HTML page to be loaded in an iframe.

To achieve this, you can create an assets directory which will be copied over to the final build. Each file will be available at the URL assets/filename.extension. Subdirectories are also allowed.

For example, you might want to create assets/img/ACME_logo.png, and use this in templates/navbar.html (see Navbar and Footer for more info):

<nav class="navbar navbar-inverse">
  <div class="container-fluid">
    <div class="navbar-header">
      <img src="assets/img/ACME_logo.png">

CSS and JavaScript

You can add CSS and JavaScript files to the page by creating directories styles/ and javascript/. The files in these directories will be concatenated and included in the final page, in alphabetical order. They will be loaded after all third-party libraries (such as jQuery), but before the app is initialized.

If ordering is important, or if you want to include JS/CSS from external URLs, you can also specify the javascript and css fields in LucyBot.yml:

  - assets/css/acme_styles.css