Yannick Warnier 76a0eae5ea Add static resources and remove tests dir for beta release | 5 years ago | |
---|---|---|
.. | ||
css | 5 years ago | |
fonts | 5 years ago | |
LICENSE | 5 years ago | |
README.md | 5 years ago | |
couscous.yml | 5 years ago | |
default.twig | 5 years ago |
To use the template, set it up in your couscous.yml
configuration file:
template:
url: https://github.com/CouscousPHP/Template-Dark
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:
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
To set the current menu item (i.e. highlighted menu item), set the currentMenu
key in the Markdown files:
---
currentMenu: home
---
# Welcome