Merge pull request #5131 from stevecheckoway/default-docs
Merge pull request 5131
This commit is contained in:
commit
5e3f9cdd4f
|
@ -571,11 +571,13 @@ file or on the command-line.
|
||||||
# Where things are
|
# Where things are
|
||||||
source: .
|
source: .
|
||||||
destination: ./_site
|
destination: ./_site
|
||||||
plugins_dir: ./_plugins
|
plugins_dir: _plugins
|
||||||
layouts_dir: ./_layouts
|
layouts_dir: _layouts
|
||||||
data_dir: ./_data
|
data_dir: _data
|
||||||
includes_dir: ./_includes
|
includes_dir: _includes
|
||||||
collections: null
|
collections:
|
||||||
|
posts:
|
||||||
|
output: true
|
||||||
|
|
||||||
# Handling Reading
|
# Handling Reading
|
||||||
safe: false
|
safe: false
|
||||||
|
@ -607,6 +609,7 @@ detach: false
|
||||||
port: 4000
|
port: 4000
|
||||||
host: 127.0.0.1
|
host: 127.0.0.1
|
||||||
baseurl: "" # does not include hostname
|
baseurl: "" # does not include hostname
|
||||||
|
show_dir_listing: false
|
||||||
|
|
||||||
# Outputting
|
# Outputting
|
||||||
permalink: date
|
permalink: date
|
||||||
|
@ -614,8 +617,12 @@ paginate_path: /page:num
|
||||||
timezone: null
|
timezone: null
|
||||||
|
|
||||||
quiet: false
|
quiet: false
|
||||||
|
verbose: false
|
||||||
defaults: []
|
defaults: []
|
||||||
|
|
||||||
|
liquid:
|
||||||
|
error_mode: warn
|
||||||
|
|
||||||
# Markdown Processors
|
# Markdown Processors
|
||||||
rdiscount:
|
rdiscount:
|
||||||
extensions: []
|
extensions: []
|
||||||
|
@ -629,17 +636,20 @@ kramdown:
|
||||||
entity_output: as_char
|
entity_output: as_char
|
||||||
toc_levels: 1..6
|
toc_levels: 1..6
|
||||||
smart_quotes: lsquo,rsquo,ldquo,rdquo
|
smart_quotes: lsquo,rsquo,ldquo,rdquo
|
||||||
enable_coderay: false
|
input: GFM
|
||||||
|
hard_wrap: false
|
||||||
coderay:
|
footnote_nr: 1
|
||||||
coderay_wrap: div
|
|
||||||
coderay_line_numbers: inline
|
|
||||||
coderay_line_number_start: 1
|
|
||||||
coderay_tab_width: 4
|
|
||||||
coderay_bold_every: 10
|
|
||||||
coderay_css: style
|
|
||||||
{% endhighlight %}
|
{% endhighlight %}
|
||||||
|
|
||||||
|
## Liquid Options
|
||||||
|
|
||||||
|
Liquid's response to errors can be configured by setting `error_mode`. The
|
||||||
|
options are
|
||||||
|
|
||||||
|
- `lax` --- Ignore all errors.
|
||||||
|
- `warn` --- Output a warning on the console for each error.
|
||||||
|
- `strict` --- Output an error message and stop the build.
|
||||||
|
|
||||||
## Markdown Options
|
## Markdown Options
|
||||||
|
|
||||||
The various Markdown renderers supported by Jekyll sometimes have extra options
|
The various Markdown renderers supported by Jekyll sometimes have extra options
|
||||||
|
@ -689,16 +699,6 @@ extensions are:
|
||||||
|
|
||||||
[redcarpet_extensions]: https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use
|
[redcarpet_extensions]: https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use
|
||||||
|
|
||||||
### Kramdown
|
|
||||||
|
|
||||||
In addition to the defaults mentioned above, you can also turn on recognition
|
|
||||||
of GitHub Flavored Markdown by passing an `input` option with a value of "GFM".
|
|
||||||
|
|
||||||
For example, in your `_config.yml`:
|
|
||||||
|
|
||||||
kramdown:
|
|
||||||
input: GFM
|
|
||||||
|
|
||||||
### Custom Markdown Processors
|
### Custom Markdown Processors
|
||||||
|
|
||||||
If you're interested in creating a custom markdown processor, you're in luck! Create a new class in the `Jekyll::Converters::Markdown` namespace:
|
If you're interested in creating a custom markdown processor, you're in luck! Create a new class in the `Jekyll::Converters::Markdown` namespace:
|
||||||
|
|
Loading…
Reference in New Issue