MyCLabs Couscous template
CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
public
.gitignore
README.md
couscous.yml
page.twig

README.md

MyCLabs template for Couscous

Usage

To use the template, set it up in your couscous.yml configuration file:

templateUrl: https://github.com/myclabs/couscous-template

This template is used by:

Configuration

Here are all the variables you can set in your couscous.yml:

template:
    # Base URL of the published website
    baseUrl: http://mnapoli.github.io/Couscous

    github:
        user: hello
        repo: my-project

    title: My project
    subTitle: This is a great project.

    # The left menu bar
    menu:
        sections:
            main:
                name: Main documentation
                items:
                    home:
                        text: Home page
                        # You can use relative urls
                        relativeUrl: doc/faq.html
                    foo:
                        text: Another link
                        # Or absolute urls
                        absoluteUrl: https://example.com
            other:
                name: Other topics
                items:

Note that the menu items can also contain HTML:

home:
    text: '<i class="fa fa-github"></i> Home page'
    relativeUrl: doc/faq.html

Menu

To set the current menu item (i.e. highlighted menu item), set the currentMenu key in the Markdown files:

---
currentMenu: home
---

# Welcome