diff --git a/.idea/workspace.xml b/.idea/workspace.xml index 72e1776..7e97b79 100644 --- a/.idea/workspace.xml +++ b/.idea/workspace.xml @@ -144,11 +144,91 @@ - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -157,37 +237,11 @@ - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + @@ -198,10 +252,6 @@ @@ -260,10 +314,9 @@ - @@ -289,6 +342,7 @@ + @@ -483,7 +537,6 @@ - @@ -574,26 +627,26 @@ - + - + - - + + @@ -636,11 +689,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - @@ -651,7 +748,6 @@ - @@ -659,7 +755,6 @@ - @@ -667,7 +762,6 @@ - @@ -675,7 +769,6 @@ - @@ -715,7 +808,6 @@ - @@ -853,80 +945,20 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -934,7 +966,6 @@ - @@ -942,7 +973,23 @@ - + + + + + + + + + + + + + + + + + @@ -953,7 +1000,6 @@ - @@ -962,19 +1008,98 @@ - + - - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -982,13 +1107,5 @@ - - - - - - - - \ No newline at end of file diff --git a/LICENSE-BSD.txt b/LICENSE-BSD.txt new file mode 100644 index 0000000..50ba663 --- /dev/null +++ b/LICENSE-BSD.txt @@ -0,0 +1,25 @@ +Copyright (c) 2013, Christodoulos Tsoulloftas, http://www.komposta.net +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + * Neither the name of the nor the names of its + contributors may be used to endorse or promote products derived from this + software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/build_designer.sh b/build_designer.sh index 73f4a2b..dfd138c 100644 --- a/build_designer.sh +++ b/build_designer.sh @@ -1 +1 @@ -jekyll serve --config configs/config_designer.yml --destination /users/tjohnson/projects/documentation-theme-jekyll-builds/designer \ No newline at end of file +jekyll serve --config configs/config_designer.yml --destination ../documentation-theme-jekyll-builds/designer \ No newline at end of file diff --git a/build_designer_pdf.sh b/build_designer_pdf.sh index 76da992..1193371 100644 --- a/build_designer_pdf.sh +++ b/build_designer_pdf.sh @@ -1,2 +1,2 @@ -jekyll serve --config configs/config_designer_pdf.yml --destination /users/tjohnson/projects/documentation-theme-jekyll-builds/designer_guide.pdf +jekyll serve --config configs/config_designer_pdf.yml --destination ../documentation-theme-jekyll-builds/designer_guide.pdf diff --git a/build_designer_prince.sh b/build_designer_prince.sh index 807240e..33b2619 100644 --- a/build_designer_prince.sh +++ b/build_designer_prince.sh @@ -1 +1 @@ -prince --input-list=/users/tjohnson/projects/documentation-theme-jekyll-builds/designer-pdf/prince-file-list.txt -o /users/tjohnson/projects/documentation-theme-jekyll-builds/pdf-output/designer.pdf \ No newline at end of file +prince --input-list=../documentation-theme-jekyll-builds/designer-pdf/prince-file-list.txt -o ../documentation-theme-jekyll-builds/pdf-output/designer.pdf \ No newline at end of file diff --git a/build_writer.sh b/build_writer.sh index 72e530e..6002296 100644 --- a/build_writer.sh +++ b/build_writer.sh @@ -1,2 +1,2 @@ -jekyll serve --config configs/config_writer.yml --destination /users/tjohnson/projects/documentation-theme-jekyll-builds/writer +jekyll serve --config configs/config_writer.yml --destination ../documentation-theme-jekyll-builds/writer diff --git a/build_writer_pdf.sh b/build_writer_pdf.sh index 985b2a9..7a93126 100644 --- a/build_writer_pdf.sh +++ b/build_writer_pdf.sh @@ -1 +1 @@ -jekyll serve --config configs/config_writer_pdf.yml --destination /users/tjohnson/projects/documentation-theme-jekyll-builds/writer_guide.pdf +jekyll serve --config configs/config_writer_pdf.yml --destination ../documentation-theme-jekyll-builds/writer_guide.pdf diff --git a/build_writer_prince.sh b/build_writer_prince.sh index 82df32a..5291708 100644 --- a/build_writer_prince.sh +++ b/build_writer_prince.sh @@ -1 +1 @@ -prince --input-list=/users/tjohnson/projects/documentation-theme-jekyll-builds/writer-pdf/prince-file-list.txt -o /users/tjohnson/projects/documentation-theme-jekyll-builds/pdf-output/writer.pdf \ No newline at end of file +prince --input-list=../documentation-theme-jekyll-builds/writer-pdf/prince-file-list.txt -o ../documentation-theme-jekyll-builds/pdf-output/writer.pdf \ No newline at end of file diff --git a/configs/config_designer.yml b/configs/config_designer.yml index becda29..e63c143 100644 --- a/configs/config_designer.yml +++ b/configs/config_designer.yml @@ -36,7 +36,7 @@ markdown: redcarpet # options for the redcarpet markdown processing. leave as is, especially the "with_toc_data" or the mini-toc won't appear. redcarpet: extensions: ["no_intra_emphasis", "fenced_code_blocks", "autolink", "tables", "with_toc_data"] -highlighter: rouge +highlighter: pygments # put all files or directories that you want to exclude from your project here. exclude: diff --git a/configs/config_designer_pdf.yml b/configs/config_designer_pdf.yml index e81875c..886ba8b 100644 --- a/configs/config_designer_pdf.yml +++ b/configs/config_designer_pdf.yml @@ -27,7 +27,7 @@ markdown: redcarpet # options for the redcarpet markdown processing. leave as is, especially the "with_toc_data" or the mini-toc won't appear. redcarpet: extensions: ["no_intra_emphasis", "fenced_code_blocks", "autolink", "tables", "with_toc_data"] -highlighter: rouge +highlighter: pygments # put all files or directories that you want to exclude from your project here. exclude: diff --git a/configs/config_writer.yml b/configs/config_writer.yml index e439cc4..518045d 100644 --- a/configs/config_writer.yml +++ b/configs/config_writer.yml @@ -36,7 +36,7 @@ markdown: redcarpet # options for the redcarpet markdown processing. leave as is, especially the "with_toc_data" or the mini-toc won't appear. redcarpet: extensions: ["no_intra_emphasis", "fenced_code_blocks", "autolink", "tables", "with_toc_data"] -highlighter: rouge +highlighter: pygments # put all files or directories that you want to exclude from your project here. exclude: diff --git a/configs/config_writer_pdf.yml b/configs/config_writer_pdf.yml index 8ea3aef..f3e49b9 100644 --- a/configs/config_writer_pdf.yml +++ b/configs/config_writer_pdf.yml @@ -26,7 +26,7 @@ markdown: redcarpet # options for the redcarpet markdown processing. leave as is, especially the "with_toc_data" or the mini-toc won't appear. redcarpet: extensions: ["no_intra_emphasis", "fenced_code_blocks", "autolink", "tables", "with_toc_data"] -highlighter: rouge +highlighter: pygments # put all files or directories that you want to exclude from your project here. exclude: diff --git a/pages/overview/getting_started.md b/pages/overview/getting_started.md index 6dc9cdf..f72c2e1 100644 --- a/pages/overview/getting_started.md +++ b/pages/overview/getting_started.md @@ -14,6 +14,7 @@ audience: writer, designer * [Git](http://git-scm.com/download/mac). Type `which git` to see if you already have it installed. * Text editor (some examples: Sublime Text, Atom, WebStorm) * [iTerm](http://iterm.sourceforge.net/) - optional but recommended instead of Terminal. +* [pygments](http://pygments.org/download/) - Pygments handles syntax highlighting. In my experiments, the highlighting seemed better than the default rouge. To install Pygments, you will need Python installed. (If you don't install pygments, you'll get an error when you build the theme.) {{warning}} These instructions are designed for users on Macs. Jekyllrb supposedly works on Windows but is not officially supported on that platform. See http://jekyllrb.com/docs/windows/ for more details. {{end}}