kramdown adjustments
This commit is contained in:
3
Gemfile
3
Gemfile
@ -1,4 +1,3 @@
|
|||||||
source 'https://rubygems.org'
|
source 'https://rubygems.org'
|
||||||
#gem 'github-pages'
|
|
||||||
|
|
||||||
gem 'jekyll', '~> 3.0'
|
gem 'github-pages'
|
120
Gemfile.lock
120
Gemfile.lock
@ -1,39 +1,141 @@
|
|||||||
GEM
|
GEM
|
||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
specs:
|
specs:
|
||||||
|
RedCloth (4.2.9)
|
||||||
|
activesupport (4.2.5)
|
||||||
|
i18n (~> 0.7)
|
||||||
|
json (~> 1.7, >= 1.7.7)
|
||||||
|
minitest (~> 5.1)
|
||||||
|
thread_safe (~> 0.3, >= 0.3.4)
|
||||||
|
tzinfo (~> 1.1)
|
||||||
|
addressable (2.3.8)
|
||||||
|
blankslate (2.1.2.4)
|
||||||
|
classifier-reborn (2.0.4)
|
||||||
|
fast-stemmer (~> 1.0)
|
||||||
|
coffee-script (2.4.1)
|
||||||
|
coffee-script-source
|
||||||
|
execjs
|
||||||
|
coffee-script-source (1.10.0)
|
||||||
colorator (0.1)
|
colorator (0.1)
|
||||||
|
ethon (0.8.0)
|
||||||
|
ffi (>= 1.3.0)
|
||||||
|
execjs (2.6.0)
|
||||||
|
faraday (0.9.2)
|
||||||
|
multipart-post (>= 1.2, < 3)
|
||||||
|
fast-stemmer (1.0.2)
|
||||||
ffi (1.9.10)
|
ffi (1.9.10)
|
||||||
jekyll (3.1.1)
|
gemoji (2.1.0)
|
||||||
|
github-pages (39)
|
||||||
|
RedCloth (= 4.2.9)
|
||||||
|
github-pages-health-check (~> 0.2)
|
||||||
|
jekyll (= 2.4.0)
|
||||||
|
jekyll-coffeescript (= 1.0.1)
|
||||||
|
jekyll-feed (= 0.3.1)
|
||||||
|
jekyll-mentions (= 0.2.1)
|
||||||
|
jekyll-redirect-from (= 0.8.0)
|
||||||
|
jekyll-sass-converter (= 1.3.0)
|
||||||
|
jekyll-sitemap (= 0.8.1)
|
||||||
|
jemoji (= 0.5.0)
|
||||||
|
kramdown (= 1.5.0)
|
||||||
|
liquid (= 2.6.2)
|
||||||
|
maruku (= 0.7.0)
|
||||||
|
mercenary (~> 0.3)
|
||||||
|
pygments.rb (= 0.6.3)
|
||||||
|
rdiscount (= 2.1.7)
|
||||||
|
redcarpet (= 3.3.2)
|
||||||
|
terminal-table (~> 1.4)
|
||||||
|
github-pages-health-check (0.5.3)
|
||||||
|
addressable (~> 2.3)
|
||||||
|
net-dns (~> 0.8)
|
||||||
|
public_suffix (~> 1.4)
|
||||||
|
typhoeus (~> 0.7)
|
||||||
|
html-pipeline (1.9.0)
|
||||||
|
activesupport (>= 2)
|
||||||
|
nokogiri (~> 1.4)
|
||||||
|
i18n (0.7.0)
|
||||||
|
jekyll (2.4.0)
|
||||||
|
classifier-reborn (~> 2.0)
|
||||||
colorator (~> 0.1)
|
colorator (~> 0.1)
|
||||||
|
jekyll-coffeescript (~> 1.0)
|
||||||
|
jekyll-gist (~> 1.0)
|
||||||
|
jekyll-paginate (~> 1.0)
|
||||||
jekyll-sass-converter (~> 1.0)
|
jekyll-sass-converter (~> 1.0)
|
||||||
jekyll-watch (~> 1.1)
|
jekyll-watch (~> 1.1)
|
||||||
kramdown (~> 1.3)
|
kramdown (~> 1.3)
|
||||||
liquid (~> 3.0)
|
liquid (~> 2.6.1)
|
||||||
mercenary (~> 0.3.3)
|
mercenary (~> 0.3.3)
|
||||||
rouge (~> 1.7)
|
pygments.rb (~> 0.6.0)
|
||||||
|
redcarpet (~> 3.1)
|
||||||
safe_yaml (~> 1.0)
|
safe_yaml (~> 1.0)
|
||||||
jekyll-sass-converter (1.4.0)
|
toml (~> 0.1.0)
|
||||||
sass (~> 3.4)
|
jekyll-coffeescript (1.0.1)
|
||||||
|
coffee-script (~> 2.2)
|
||||||
|
jekyll-feed (0.3.1)
|
||||||
|
jekyll-gist (1.4.0)
|
||||||
|
octokit (~> 4.2)
|
||||||
|
jekyll-mentions (0.2.1)
|
||||||
|
html-pipeline (~> 1.9.0)
|
||||||
|
jekyll (~> 2.0)
|
||||||
|
jekyll-paginate (1.1.0)
|
||||||
|
jekyll-redirect-from (0.8.0)
|
||||||
|
jekyll (>= 2.0)
|
||||||
|
jekyll-sass-converter (1.3.0)
|
||||||
|
sass (~> 3.2)
|
||||||
|
jekyll-sitemap (0.8.1)
|
||||||
jekyll-watch (1.3.0)
|
jekyll-watch (1.3.0)
|
||||||
listen (~> 3.0)
|
listen (~> 3.0)
|
||||||
kramdown (1.9.0)
|
jemoji (0.5.0)
|
||||||
liquid (3.0.6)
|
gemoji (~> 2.0)
|
||||||
|
html-pipeline (~> 1.9)
|
||||||
|
jekyll (>= 2.0)
|
||||||
|
json (1.8.3)
|
||||||
|
kramdown (1.5.0)
|
||||||
|
liquid (2.6.2)
|
||||||
listen (3.0.5)
|
listen (3.0.5)
|
||||||
rb-fsevent (>= 0.9.3)
|
rb-fsevent (>= 0.9.3)
|
||||||
rb-inotify (>= 0.9)
|
rb-inotify (>= 0.9)
|
||||||
|
maruku (0.7.0)
|
||||||
mercenary (0.3.5)
|
mercenary (0.3.5)
|
||||||
|
mini_portile2 (2.0.0)
|
||||||
|
minitest (5.8.3)
|
||||||
|
multipart-post (2.0.0)
|
||||||
|
net-dns (0.8.0)
|
||||||
|
nokogiri (1.6.7.1)
|
||||||
|
mini_portile2 (~> 2.0.0.rc2)
|
||||||
|
octokit (4.2.0)
|
||||||
|
sawyer (~> 0.6.0, >= 0.5.3)
|
||||||
|
parslet (1.5.0)
|
||||||
|
blankslate (~> 2.0)
|
||||||
|
posix-spawn (0.3.11)
|
||||||
|
public_suffix (1.5.2)
|
||||||
|
pygments.rb (0.6.3)
|
||||||
|
posix-spawn (~> 0.3.6)
|
||||||
|
yajl-ruby (~> 1.2.0)
|
||||||
rb-fsevent (0.9.7)
|
rb-fsevent (0.9.7)
|
||||||
rb-inotify (0.9.5)
|
rb-inotify (0.9.5)
|
||||||
ffi (>= 0.5.0)
|
ffi (>= 0.5.0)
|
||||||
rouge (1.10.1)
|
rdiscount (2.1.7)
|
||||||
|
redcarpet (3.3.2)
|
||||||
safe_yaml (1.0.4)
|
safe_yaml (1.0.4)
|
||||||
sass (3.4.21)
|
sass (3.4.21)
|
||||||
|
sawyer (0.6.0)
|
||||||
|
addressable (~> 2.3.5)
|
||||||
|
faraday (~> 0.8, < 0.10)
|
||||||
|
terminal-table (1.5.2)
|
||||||
|
thread_safe (0.3.5)
|
||||||
|
toml (0.1.2)
|
||||||
|
parslet (~> 1.5.0)
|
||||||
|
typhoeus (0.8.0)
|
||||||
|
ethon (>= 0.8.0)
|
||||||
|
tzinfo (1.2.2)
|
||||||
|
thread_safe (~> 0.1)
|
||||||
|
yajl-ruby (1.2.1)
|
||||||
|
|
||||||
PLATFORMS
|
PLATFORMS
|
||||||
ruby
|
ruby
|
||||||
|
|
||||||
DEPENDENCIES
|
DEPENDENCIES
|
||||||
jekyll (~> 3.0)
|
github-pages
|
||||||
|
|
||||||
BUNDLED WITH
|
BUNDLED WITH
|
||||||
1.10.6
|
1.10.6
|
||||||
|
@ -16,6 +16,9 @@ github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/reviews
|
|||||||
disqus_shortname: idrbwjekyll
|
disqus_shortname: idrbwjekyll
|
||||||
# variables
|
# variables
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
sidebar_tagline: Designers
|
sidebar_tagline: Designers
|
||||||
sidebar_version: Version 4.0
|
sidebar_version: Version 4.0
|
||||||
theme_file: theme-blue.css
|
theme_file: theme-blue.css
|
||||||
@ -25,7 +28,7 @@ pdf_file_name: mydoc_designers_pdf.pdf
|
|||||||
|
|
||||||
#gems:
|
#gems:
|
||||||
# - algoliasearch-jekyll
|
# - algoliasearch-jekyll
|
||||||
algolia:
|
#algolia:
|
||||||
# application_id: 'HXUBJERYYB'
|
# application_id: 'HXUBJERYYB'
|
||||||
# index_name: 'documentation_theme_jekyll_designers'
|
# index_name: 'documentation_theme_jekyll_designers'
|
||||||
port: 4009
|
port: 4009
|
||||||
|
@ -39,7 +39,9 @@
|
|||||||
|
|
||||||
<!-- Content Column -->
|
<!-- Content Column -->
|
||||||
<div class="col-md-9">
|
<div class="col-md-9">
|
||||||
<!--{% include algolia.html %}-->
|
{% comment %}
|
||||||
|
{% include algolia.html %}
|
||||||
|
{% endcomment %}
|
||||||
{{content}}
|
{{content}}
|
||||||
</div><!-- /.row -->
|
</div><!-- /.row -->
|
||||||
|
|
||||||
|
@ -12,51 +12,27 @@ site_title: Jekyll theme for designers
|
|||||||
project_folder: mydoc
|
project_folder: mydoc
|
||||||
company_name: Your company
|
company_name: Your company
|
||||||
footer_image_location: ../common_images/company_logo.png
|
footer_image_location: ../common_images/company_logo.png
|
||||||
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/docreviews
|
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/reviews
|
||||||
disqus_shortname: idrbwjekyll
|
disqus_shortname: idrbwjekyll
|
||||||
# variables
|
# variables
|
||||||
|
|
||||||
|
markdown: kramdown
|
||||||
|
kramdown:
|
||||||
|
auto_ids: true
|
||||||
|
|
||||||
|
|
||||||
sidebar_tagline: Designers
|
sidebar_tagline: Designers
|
||||||
sidebar_version: Version 4.0
|
sidebar_version: Version 4.0
|
||||||
theme_file: theme-blue.css
|
theme_file: theme-blue.css
|
||||||
pdf_file_name: mydoc_designers_pdf.pdf
|
pdf_file_name: mydoc_designers_pdf.pdf
|
||||||
|
|
||||||
# algolia settings
|
# the algolia entries here are experimental only.
|
||||||
gems:
|
|
||||||
- algoliasearch-jekyll
|
|
||||||
|
|
||||||
algolia:
|
|
||||||
application_id: 'HXUBJERYYB'
|
|
||||||
index_name: 'documentation_theme_jekyll_designers'
|
|
||||||
search_only_api_key: '82f9e5197317a79bdec5f45ec91bf4e7'
|
|
||||||
record_css_selector: 'p,ul'
|
|
||||||
excluded_files:
|
|
||||||
- _data
|
|
||||||
- _drafts
|
|
||||||
- _includes
|
|
||||||
- _layouts
|
|
||||||
- _tooltips
|
|
||||||
- css
|
|
||||||
- fonts
|
|
||||||
- js
|
|
||||||
- licenses
|
|
||||||
- mydoc/images
|
|
||||||
- _site
|
|
||||||
- _drafts
|
|
||||||
- configs/
|
|
||||||
- doc/mydoc_writers*
|
|
||||||
settings:
|
|
||||||
attributesToIndex:
|
|
||||||
- title
|
|
||||||
- h1
|
|
||||||
- h2
|
|
||||||
- h3
|
|
||||||
- h4
|
|
||||||
- h5
|
|
||||||
- h6
|
|
||||||
- summary
|
|
||||||
- body
|
|
||||||
|
|
||||||
|
#gems:
|
||||||
|
# - algoliasearch-jekyll
|
||||||
|
#algolia:
|
||||||
|
# application_id: 'HXUBJERYYB'
|
||||||
|
# index_name: 'documentation_theme_jekyll_designers'
|
||||||
port: 4009
|
port: 4009
|
||||||
|
|
||||||
exclude:
|
exclude:
|
||||||
@ -69,12 +45,7 @@ exclude:
|
|||||||
host: 127.0.0.1
|
host: 127.0.0.1
|
||||||
feedback_email: tomjohnson1492@gmail.com
|
feedback_email: tomjohnson1492@gmail.com
|
||||||
|
|
||||||
markdown: redcarpet
|
highlighter: rouge
|
||||||
|
|
||||||
redcarpet:
|
|
||||||
extensions: ["no_intra_emphasis", "fenced_code_blocks", "tables", "with_toc_data"]
|
|
||||||
|
|
||||||
highlighter: pygments
|
|
||||||
|
|
||||||
collections:
|
collections:
|
||||||
tooltips:
|
tooltips:
|
||||||
|
@ -1,44 +1,63 @@
|
|||||||
# project definitions
|
# project definitions
|
||||||
project: mydoc_writers
|
project: mydoc_designers
|
||||||
audience: writers
|
audience: designers
|
||||||
product: doc
|
product: doc
|
||||||
platform: all
|
platform: all
|
||||||
version: all
|
version: all
|
||||||
output: web
|
output: web
|
||||||
destination: ../doc_outputs/mydoc/writers
|
destination: ../doc_outputs/mydoc/designers
|
||||||
topnav_title: Jekyll Documentation Theme
|
topnav_title: Jekyll Documentation Theme
|
||||||
homepage_title: Jekyll doc theme for writers
|
homepage_title: Jekyll doc theme for designers
|
||||||
site_title: Jekyll theme for writers
|
site_title: Jekyll theme for designers
|
||||||
project_folder: mydoc
|
project_folder: mydoc
|
||||||
company_name: Your company
|
company_name: Your company
|
||||||
footer_image_location: ../common_images/company_logo.png
|
footer_image_location: ../common_images/company_logo.png
|
||||||
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/docreviews
|
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/reviews
|
||||||
disqus_shortname: idrbwjekyll
|
disqus_shortname: idrbwjekyll
|
||||||
# variables
|
# variables
|
||||||
|
|
||||||
sidebar_tagline: Writers
|
markdown: kramdown
|
||||||
sidebar_version: Version 4.0
|
kramdown:
|
||||||
theme_file: theme-green.css
|
auto_ids: true
|
||||||
pdf_file_name: mydoc_writers_pdf.pdf
|
footnote_nr: 1
|
||||||
|
entity_output: as_char
|
||||||
|
toc_levels: 1..6
|
||||||
|
smart_quotes: lsquo,rsquo,ldquo,rdquo
|
||||||
|
enable_coderay: false
|
||||||
|
|
||||||
|
coderay:
|
||||||
|
coderay_wrap: div
|
||||||
|
coderay_line_numbers: inline
|
||||||
|
coderay_line_number_start: 1
|
||||||
|
coderay_tab_width: 4
|
||||||
|
coderay_bold_every: 10
|
||||||
|
coderay_css: style
|
||||||
|
|
||||||
|
sidebar_tagline: Designers
|
||||||
|
sidebar_version: Version 4.0
|
||||||
|
theme_file: theme-blue.css
|
||||||
|
pdf_file_name: mydoc_designers_pdf.pdf
|
||||||
|
|
||||||
|
# the algolia entries here are experimental only.
|
||||||
|
|
||||||
|
#gems:
|
||||||
|
# - algoliasearch-jekyll
|
||||||
|
#algolia:
|
||||||
|
# application_id: 'HXUBJERYYB'
|
||||||
|
# index_name: 'documentation_theme_jekyll_designers'
|
||||||
port: 4009
|
port: 4009
|
||||||
|
|
||||||
exclude:
|
exclude:
|
||||||
- _site
|
- _site
|
||||||
- _drafts
|
- _drafts
|
||||||
- configs/
|
- configs/
|
||||||
- doc/mydoc_designers*
|
- doc/mydoc_writers*
|
||||||
|
|
||||||
# same for all
|
# same for all
|
||||||
host: 127.0.0.1
|
host: 127.0.0.1
|
||||||
feedback_email: tomjohnson1492@gmail.com
|
feedback_email: tomjohnson1492@gmail.com
|
||||||
|
|
||||||
markdown: redcarpet
|
highlighter: rouge
|
||||||
|
|
||||||
redcarpet:
|
|
||||||
extensions: ["no_intra_emphasis", "fenced_code_blocks", "tables", "with_toc_data"]
|
|
||||||
|
|
||||||
highlighter: pygments
|
|
||||||
|
|
||||||
collections:
|
collections:
|
||||||
tooltips:
|
tooltips:
|
||||||
|
@ -42,6 +42,7 @@ audience: writers
|
|||||||
On a page in my site (it can be HTML or markdown), I can conditionalize content using the following:
|
On a page in my site (it can be HTML or markdown), I can conditionalize content using the following:
|
||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
|
|
||||||
```liquid
|
```liquid
|
||||||
{% if site.audience == "writers" %}
|
{% if site.audience == "writers" %}
|
||||||
The writer audience should see this...
|
The writer audience should see this...
|
||||||
@ -49,6 +50,7 @@ The writer audience should see this...
|
|||||||
The designer audience should see this ...
|
The designer audience should see this ...
|
||||||
{% endif %}
|
{% endif %}
|
||||||
```
|
```
|
||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
This uses simple `if-elsif` logic to determine what is shown (note the spelling of `elsif`). The `else` statement handles all other conditions not handled by the `if` statements.
|
This uses simple `if-elsif` logic to determine what is shown (note the spelling of `elsif`). The `else` statement handles all other conditions not handled by the `if` statements.
|
||||||
|
@ -10,6 +10,7 @@ weight: 9
|
|||||||
---
|
---
|
||||||
|
|
||||||
{{site.data.alerts.tip}} More details about generating PDFs are listed in {{site.data.mydoc.mydoc_urls.mydoc_generating_pdfs.link}}. {{site.data.alerts.end}}
|
{{site.data.alerts.tip}} More details about generating PDFs are listed in {{site.data.mydoc.mydoc_urls.mydoc_generating_pdfs.link}}. {{site.data.alerts.end}}
|
||||||
|
|
||||||
## Install Prince XML
|
## Install Prince XML
|
||||||
|
|
||||||
Prince XML is a utility I've decided to use to create PDFs. The Prince XML utility requires a list of web pages from which it can construct a PDF.
|
Prince XML is a utility I've decided to use to create PDFs. The Prince XML utility requires a list of web pages from which it can construct a PDF.
|
||||||
|
@ -6,7 +6,7 @@ last_updated: November 30, 2015
|
|||||||
summary: "You can apply syntax highlighting to your code. This theme uses pygments and applies color coding based on the lexer you specify."
|
summary: "You can apply syntax highlighting to your code. This theme uses pygments and applies color coding based on the lexer you specify."
|
||||||
---
|
---
|
||||||
|
|
||||||
|
{% comment %}
|
||||||
## About syntax highlighting
|
## About syntax highlighting
|
||||||
For syntax highlighting, use fenced code blocks optionally followed by the language syntax you want:
|
For syntax highlighting, use fenced code blocks optionally followed by the language syntax you want:
|
||||||
|
|
||||||
@ -52,16 +52,14 @@ It renders the same:
|
|||||||
The theme has syntax highlighting specified in the configuration file as follows:
|
The theme has syntax highlighting specified in the configuration file as follows:
|
||||||
|
|
||||||
```
|
```
|
||||||
highlighter: pygments
|
highlighter: rouge
|
||||||
```
|
```
|
||||||
|
|
||||||
You can use another highlighter such as `rouge`.
|
|
||||||
|
|
||||||
The syntax highlighting is done via the css/syntax.css file.
|
The syntax highlighting is done via the css/syntax.css file.
|
||||||
|
{% endcomment %}
|
||||||
|
## Available lexers
|
||||||
|
|
||||||
## Available Pygments lexers
|
The keywords you must add to specify the highlighting (in the previous example, `ruby`) are called "lexers." You can search for "lexers." Here are some common ones I use:
|
||||||
|
|
||||||
The keywords you must add to specify the highlighting (in the previous example, `ruby`) are called "lexers." You can search for "pygments lexers" or go directly to [Available lexers](http://pygments.org/docs/lexers/) to see what values you can use. Here are some common ones I use:
|
|
||||||
|
|
||||||
* js
|
* js
|
||||||
* html
|
* html
|
||||||
|
Reference in New Issue
Block a user