template-dark's Introduction

currentMenu
home

Couscous Dark template

Usage

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

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

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:
    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

Contributors

Stargazers

Watchers

template-dark's Issues

Extensible layout (without download)?

First of all thanks for your work on Couscous: it's awesome!

I'm building a project docs with Couscous and wanted to test this template. I tried to put html content (nothing more than a <em>) in project subtitle in couscous.yml, however it isn't rendered properly because raw twig filter is not set in the layout.

In addition, there is no block to override in a custom layout, so I need to download the entire template in project folder (instead of simply link this repo in couscous.yml) and write a custom default.twig just to output an innocent italic string in the subtitle.

I think would be a great thing if you add a raw filter for title and subtitle. Or, at least, wrap in a {% block header %} the <header> tag in default layout...

This can apply to other layout parts: e.g. if I only need to add a single js script I need to download the entire template, where if <script> tags were wrapped in a {% block scripts %} that task would be a lot easier.

couscousphp / template-dark Goto Github PK

template-dark's Introduction

Couscous Dark template

Usage

Configuration

Menu

template-dark's People

Contributors

Stargazers

Watchers

Forkers

template-dark's Issues

Extensible layout (without download)?

Can't scroll menu

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent