blob: ef3244a932c133ede9fbd715354578077c664d57 [file] [log] [blame]
font:
catalog:
# Noto Sans supports Latin, Latin-1 Supplement, Latin Extended-A, Greek, Cyrillic, Vietnamese & an assortment of symbols
# Noto Sans used for body text
Noto Sans:
normal: Noto_Sans/NotoSans-Regular.ttf
bold: Noto_Sans/NotoSans-Bold.ttf
italic: Noto_Sans/NotoSans-Italic.ttf
bold_italic: Noto_Sans/NotoSans-BoldItalic.ttf
# Inconsolata used for monospaced text & code blocks
Inconsolata:
normal: Inconsolata/Inconsolata-Regular.ttf
bold: Inconsolata/Inconsolata-Bold.ttf
italic: Inconsolata/Inconsolata-Regular.ttf
bold_italic: Inconsolata/Inconsolata-Bold.ttf
# M+1mn is from the asciidoctor-pdf project
# Provides the glyphs for callout numbers (see conum section below)
# This is a fallback font, and will only be used when it can fill in missing glyphs from other fonts
M+1mn Fallback:
normal: mplus1mn/mplus1mn-regular-ascii-conums.ttf
bold: mplus1mn/mplus1mn-bold-ascii.ttf
italic: mplus1mn/mplus1mn-italic-ascii.ttf
bold_italic: mplus1mn/mplus1mn-bold_italic-ascii.ttf
fallbacks:
- M+1mn Fallback
# page-level settings apply to the entire page
page:
background_color: '#ffffff'
layout: portrait
margin: [0.5in, 0.75in, 0.75in, 0.67in]
size: LETTER
# base-level settings are defaults for other elements
base:
align: left
# color as hex string (leading # is optional)
font_color: '#333333'
font_family: Noto Sans
font_size: 10
line_height_length: 11
line_height: $base_line_height_length / $base_font_size
font_size_large: round($base_font_size * 1.25)
font_size_small: round($base_font_size * 0.85)
font_size_min: $base_font_size * 0.75
font_style: normal
border_color: '#eeeeee'
border_radius: 4
border_width: 0.5
vertical_rhythm: 10
horizontal_rhythm: $base_line_height_length
vertical_spacing: $vertical_rhythm
link:
font_color: '#428bca'
# literal is used for inline monospaced strings in prose and in table cells
literal:
font_color: '#333333'
font_family: Inconsolata
font_size: 11
background_color: '#f5f5f5'
# code is used for source code blocks
code:
font_color: $base_font_color
font_family: $literal_font_family
font_size: ceil($base_font_size)
padding: $code_font_size
line_height: 1.25
background_color: '#f5f5f5'
border_color: '#cccccc'
border_radius: $base_border_radius
border_width: 0.75
# headings
heading:
font_color: '#d9411e'
font_family: $base_font_family
font_style: bold
# h1 is used for part titles; equivalent to 22pt due to rounding
h1_font_size: floor($base_font_size * 2.1)
# h2 is used for chapter titles; equivalent to 20pt due to rounding
h2_font_size: floor($base_font_size * 1.9)
# equivalent to 16pt due to rounding
h3_font_size: ceil($base_font_size * 1.53)
# equivalent to 13.125pt
h4_font_size: $base_font_size_large
# equivalent to 10.5pt
h5_font_size: $base_font_size
#equivalent to 8.925pt
h6_font_size: $base_font_size_small
line_height: 1.2
margin_top: $vertical_rhythm * 0.2
margin_bottom: $vertical_rhythm * 0.8
padding: [0, 0, 5, 0]
# Applies only to the title page
title_page:
align: right
logo:
top: 10%
image: image:../../images/Solr_Logo_on_white.png[pdfwidth=50%]
align: left
title:
top: 55%
font_size: $heading_h1_font_size
font_color: '#d9411e'
line_height: 0.9
subtitle:
font_size: $heading_h3_font_size
font_style: bold_italic
line_height: 1
authors:
margin_top: $base_font_size * 1.25
font_size: $base_font_size
revision:
margin_top: $base_font_size * 1.25
block:
margin_top: 0
margin_bottom: $vertical_rhythm
caption:
align: left
font:
style: italic
color: 7a2518
margin_inside: $vertical_rhythm / 3
margin_outside: 0
lead:
font_size: $base_font_size_large
line_height: 1.4
abstract:
font_color: '#5c6266'
font_size: $lead_font_size
line_height: $lead_line_height
font_style: italic
admonition:
border_color: $base_border_color
border_width: $base_border_width
padding: [0, $horizontal_rhythm, 0, $horizontal_rhythm]
icon:
tip:
name: fa-lightbulb-o
stroke_color: '#428b30'
note:
name: fa-info-circle
stroke_color: '#19407c'
warning:
name: fa-exclamation-triangle
stroke_color: '#bf0000'
caution:
name: fa-fire
stroke_color: '#bf6900'
important:
name: fa-bolt
stroke_color: '#eeea74'
blockquote:
font_color: $base_font_color
font_size: $base_font_size
font_style: italic
border_color: $base_border_color
border_width: 5
padding: [$vertical_rhythm / 2, $horizontal_rhythm, $vertical_rhythm / -2, $horizontal_rhythm + $blockquote_border_width / 2]
cite_font_size: $base_font_size_small
cite_font_color: '#999999'
#conums are used for inline callouts
conum:
font_family: M+1mn Fallback
font_color: $literal_font_color
font_size: $base_font_size_large
line_height: 4 / 3
example:
border_color: $base_border_color
border_radius: $base_border_radius
border_width: 0.75
background_color: transparent
padding: [$vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm]
image:
align: left
border_color: $base_border_color
border_radius: $base_border_radius
border_width: 0.75
prose:
margin_top: 0
margin_bottom: $vertical_rhythm
sidebar:
border_color: $page_background_color
border_radius: $base_border_radius
border_width: $base_border_width
background_color: '#eeeeee'
padding: [$vertical_rhythm, $vertical_rhythm * 1.25, 0, $vertical_rhythm * 1.25]
title:
align: center
font_color: $heading_font_color
font_family: $heading_font_family
font_size: $heading_h4_font_size
font_style: $heading_font_style
thematic_break:
border_color: $base_border_color
border_style: solid
border_width: $base_border_width
margin_top: $vertical_rhythm * 0.5
margin_bottom: $vertical_rhythm * 1.5
description_list:
term_font_style: bold
term_spacing: $vertical_rhythm / 4
description_indent: $horizontal_rhythm * 1.25
outline_list:
indent: $horizontal_rhythm * 1.5
# NOTE item_spacing applies to list items that do not have complex content
item_spacing: $vertical_rhythm / 2
table:
background_color: $page_background_color
head_background_color: '#e6e7e8'
#head_font_color: $base_font_color
head_font_style: bold
even_row_background_color: '#f9f9f9'
#odd_row_background_color: <hex value>
foot_background_color: '#f0f0f0'
border_color: '#dddddd'
border_width: $base_border_width
cell_padding: [3, 3, 6, 3]
toc:
dot_leader_color: '#dddddd'
#dot_leader_content: '. '
indent: $horizontal_rhythm
line_height: 1.4
header:
font:
size: $base_font_size
color: $base_font_color
style: bold_italic
height: $base_line_height_length * 2.5
recto_content:
left: 'Apache Solr Reference Guide {solr-docs-version}'
right: 'Page {page-number} of {page-count}'
verso_content:
left: 'Page {page-number} of {page-count}'
right: 'Apache Solr Reference Guide {solr-docs-version}'
footer:
font_size: $base_font_size_small
font_color: $base_font_color
# NOTE if background_color is set, background and border will span width of page
border_color: '#dddddd'
border_width: 0.25
height: $base_line_height_length * 2.5
line_height: 1
padding: [$base_line_height_length / 2, 1, 0, 1]
vertical_align: top
#image_vertical_align: <alignment> or <number>
# additional attributes for content:
# * {page-count}
# * {page-number}
# * {document-title}
# * {document-subtitle}
# * {chapter-title}
# * {section-title}
# * {section-or-chapter-title}
# We have added some custom variables from the build, see _config.yml.template
recto_content:
right: 'Guide Version {solr-guide-version} - Published: {build-date}'
left: '(C) {build-year}, Apache Software Foundation'
verso_content:
left: 'Guide Version {solr-guide-version} - Published: {build-date}'
right: '(C) {build-year}, Apache Software Foundation'
colophon:
font_size: $base_font_size_small