forked from jvelazquez-reyes/pipelines-jupyter-book
/
_config.yml
141 lines (112 loc) · 6.1 KB
/
_config.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
#######################################################################################
# Jekyll site settings
title: Pipeline demos
author: Mathieu Boudreau
email: mathieu.boudreau2@mail.mcgill.ca
description: >- # this means to ignore newlines until "baseurl:"
This is a set of pipeline tutorials.
baseurl: "/pipelines-jupyter-book" # the subpath of your site, e.g. /blog. If there is no subpath for your site, use an empty string ""
url: "http://mathieuboudreau.github.io" # the base hostname & protocol for your site, e.g. http://example.com
#######################################################################################
# Jupyter Book settings
# Notebook content settings
hide_cell_text : "# HIDDEN" # When building the textbook, any cells with this text inside will be hidden in the output markdown
hide_code_text : "# NO CODE" # When building the textbook, any cells with this text inside will have *only* their output shown (no code)
use_hide_code_button : true # If True, a small button appears to the right of each cell that lets you hide its contents.
# Sidebar settings
show_sidebar : true # Show the sidebar. Only set to false if your only wish to host a single page.
collapse_inactive_chapters: true # Whether to collapse the inactive chapters in the sidebar
textbook_logo : http://conp.ca/wp-content/uploads/2018/04/logo-2.png # A logo to be displayed at the top of your textbook sidebar
textbook_logo_link : https://conp-pcno.github.io # A link for the logo.
sidebar_footer_text : 'Return to <a href="https://conp-pcno.github.io">NeuroLibre</a>'
number_toc_chapters : false # Whether to add numbers to chapterse in your Table of Contents. If true, you can control this at the Chapter level in _data/toc.yml
# Search settings
search_max_words_in_content : 100 # In the search function, use at most this many words (too many words will make search slow)
# Toggle keyboard navigation
keyboard_navigation : false
#######################################################################################
# Interact link settings
# General interact settings
use_jupyterlab : true # If 'true', interact links will use JupyterLab as the interface
# Jupyterhub link settings
use_jupyterhub_button : false # If 'true', display a button that will direct users to a JupyterHub (that you provide)
jupyterhub_url : "" # The URL for your JupyterHub. If no URL, use ""
jupyterhub_interact_text : "Launch JupyterHub" # The text that interact buttons will contain.
# Binder link settings
use_binder_button : true # If 'true', add a binder button for interactive links
binderhub_url : "https://binder.conp.cloud" # The URL for your BinderHub. If no URL, use ""
binder_repo_base : "https://github.com/" # The site on which the textbook repository is hosted
binder_repo_org : "mathieuboudreau" # The username or organization that owns this repository
binder_repo_name : "pipelines-jupyter-book" # The name of the repository on the web
binder_repo_branch : "master" # The branch on which your textbook is hosted.
binderhub_interact_text : "Launch Binder" # The text that interact buttons will contain.
# Thebelab settings
use_thebelab_button : true # If 'true', display a button to allow in-page running code cells with Thebelab
thebelab_button_text : "Interact Inline" # The text to display inside the Thebelab initialization button
#######################################################################################
# Jupyter book extensions and additional features
# Bibliography and citation settings. See https://github.com/inukshuk/jekyll-scholar#configuration for options
scholar:
style: apa
#######################################################################################
# Jupyter book settings you probably don't need to change
content_folder_name : "content" # The folder where your raw content (notebooks/markdown files) are located
images_url : "/assets/images" # Path to static image files
css_url : "/assets/css" # Path to static CSS files
js_url : "/assets/js" # Path to JS files
custom_static_url : "/assets/custom" # Path to user's custom CSS/JS files
#######################################################################################
# Jekyll build settings (only modify if you know what you're doing)
# Site settings
defaults:
- scope:
path: ""
values:
layout: "default"
toc: true
toc_label: " On this page"
toc_icon: "list-ul"
favicon_path: "http://conp.ca/wp-content/uploads/2018/04/Icon.png"
# Markdown Processing
markdown: kramdown
kramdown:
input: GFM
syntax_highlighter: rouge
sass:
style: compressed
collections:
build:
output: true
permalink: /:path.html
# Exclude from processing.
# The following items will not be processed, by default. Create a custom list
# to override the default setting.
exclude:
- notebooks/
- add_section_numbers_to_book.py
- convert_notebooks_to_html_partial.py
- Gemfile
- Gemfile.lock
- node_modules
- vendor/bundle/
- vendor/cache/
- vendor/gems/
- vendor/ruby/
- scripts/
plugins:
- jekyll-redirect-from
- jekyll-scholar