Default template used by Couscous
HTML 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.
css Fixed #2 Footer linking to Couscous Dec 4, 2014
fonts Fixed #1 Dec 4, 2014
.gitignore First commit Nov 30, 2014
LICENSE First commit Nov 30, 2014
README.md escape href Dec 8, 2014
couscous.yml First commit Nov 30, 2014
default.twig Use protocol relative URL for highlight JS Jun 12, 2015
screenshot.png First commit Nov 30, 2014

README.md

currentMenu
home

Couscous Light template

Usage

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

template:
    url: https://github.com/CouscousPHP/Template-Light

Configuration

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

# Base URL of the published website
baseUrl: http://username.github.io/project

# Used to link to the GitHub project
github:
    user: myself
    repo: my-project

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

# The left menu bar
menu:
    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

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