Skip to content

Commit

Permalink
committing new version of jekyll doc theme -- 5.0, with some refineme…
Browse files Browse the repository at this point in the history
…nts to come with the documentation
  • Loading branch information
tomjoht committed Mar 19, 2016
1 parent e267cce commit 7a869d7
Show file tree
Hide file tree
Showing 206 changed files with 4,350 additions and 6,051 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
_site/
.sass-cache/
.idea
.jekyll-metadata
_pdf
.idea/
6 changes: 3 additions & 3 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
source 'https://rubygems.org'
# A sample Gemfile
source "https://rubygems.org"

# gem "rails"
gem 'github-pages'
gem 'pygments.rb'
gem 'redcarpet'
gem 'jekyll'
42 changes: 18 additions & 24 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,18 @@ GEM
multipart-post (>= 1.2, < 3)
ffi (1.9.10)
gemoji (2.1.0)
github-pages (45)
github-pages (52)
RedCloth (= 4.2.9)
github-pages-health-check (= 0.6.0)
jekyll (= 3.0.2)
github-pages-health-check (= 1.0.1)
jekyll (= 3.0.3)
jekyll-coffeescript (= 1.0.1)
jekyll-feed (= 0.3.1)
jekyll-feed (= 0.4.0)
jekyll-gist (= 1.4.0)
jekyll-mentions (= 1.0.0)
jekyll-mentions (= 1.0.1)
jekyll-paginate (= 1.1.0)
jekyll-redirect-from (= 0.9.1)
jekyll-sass-converter (= 1.3.0)
jekyll-seo-tag (= 0.1.4)
jekyll-seo-tag (= 1.3.1)
jekyll-sitemap (= 0.10.0)
jekyll-textile-converter (= 0.1.0)
jemoji (= 0.5.1)
Expand All @@ -43,16 +43,17 @@ GEM
redcarpet (= 3.3.3)
rouge (= 1.10.1)
terminal-table (~> 1.4)
github-pages-health-check (0.6.0)
github-pages-health-check (1.0.1)
addressable (~> 2.3)
net-dns (~> 0.8)
octokit (~> 4.0)
public_suffix (~> 1.4)
typhoeus (~> 0.7)
html-pipeline (2.3.0)
activesupport (>= 2, < 5)
nokogiri (>= 1.4)
i18n (0.7.0)
jekyll (3.0.2)
jekyll (3.0.3)
colorator (~> 0.1)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
Expand All @@ -63,19 +64,19 @@ GEM
safe_yaml (~> 1.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-feed (0.3.1)
jekyll-feed (0.4.0)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-mentions (1.0.0)
html-pipeline (~> 2.2)
jekyll-mentions (1.0.1)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.9.1)
jekyll (>= 2.0)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
jekyll-seo-tag (0.1.4)
jekyll (>= 2.0)
jekyll-seo-tag (1.3.1)
jekyll (~> 3.0)
jekyll-sitemap (0.10.0)
jekyll-textile-converter (0.1.0)
RedCloth (~> 4.0)
Expand All @@ -88,9 +89,9 @@ GEM
json (1.8.3)
kramdown (1.9.0)
liquid (3.0.6)
listen (3.0.5)
listen (3.0.6)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
rb-inotify (>= 0.9.7)
mercenary (0.3.5)
mini_portile2 (2.0.0)
minitest (5.8.4)
Expand All @@ -100,13 +101,9 @@ GEM
mini_portile2 (~> 2.0.0.rc2)
octokit (4.2.0)
sawyer (~> 0.6.0, >= 0.5.3)
posix-spawn (0.3.11)
public_suffix (1.5.3)
pygments.rb (0.6.3)
posix-spawn (~> 0.3.6)
yajl-ruby (~> 1.2.0)
rb-fsevent (0.9.7)
rb-inotify (0.9.5)
rb-inotify (0.9.7)
ffi (>= 0.5.0)
rdiscount (2.1.8)
redcarpet (3.3.3)
Expand All @@ -122,16 +119,13 @@ GEM
ethon (>= 0.8.0)
tzinfo (1.2.2)
thread_safe (~> 0.1)
yajl-ruby (1.2.1)

PLATFORMS
ruby

DEPENDENCIES
github-pages
jekyll
pygments.rb
redcarpet

BUNDLED WITH
1.10.6
1.11.2
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 Tom Johnson

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
69 changes: 26 additions & 43 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,62 +1,30 @@
# this is simply copied over from config/config_designers.yml

# project definitions
project: mydoc_designers
audience: designers
product: doc
platform: all
version: all
permalink: /:year/:month/:day/:title/
url: http://idratherbewriting.com
baseurl: "/documentation-theme-jekyll"
output: web
destination: ../doc_outputs/mydoc/designers
topnav_title: Jekyll Documentation Theme
homepage_title: Jekyll doc theme for designers
site_title: Jekyll theme for designers
project_folder: mydoc
company_name: Your company
footer_image_location: ../../common_images/company_logo.png
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/reviews
disqus_shortname: idrbwjekyll
# variables


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'
host: 127.0.0.1
port: 4009

exclude:
- _site
- _drafts
- configs/
- doc/mydoc_writers*

# same for all
host: 127.0.0.1
feedback_email: [email protected]

# these settings should work, but they don't seem to apply the right highlighting

#highlighter: rouge
#markdown: kramdown
#kramdown:
# input: GFM
# auto_ids: true
# hard_wrap: false
# syntax_highlighter: rouge

highlighter: pygments
markdown: redcarpet
redcarpet:
extensions: ["no_intra_emphasis", "fenced_code_blocks", "tables", "with_toc_data"]
highlighter: rouge
markdown: kramdown
kramdown:
input: GFM
auto_ids: true
hard_wrap: false
syntax_highlighter: rouge


collections:
Expand All @@ -72,6 +40,7 @@ defaults:
layout: "page"
comments: true
search: true
sidebar: home_sidebar
-
scope:
path: ""
Expand All @@ -82,3 +51,17 @@ defaults:
search: true
tooltip: true

-
scope:
path: ""
type: "posts"
values:
layout: "post"
comments: true
search: true
sidebar: tags_sidebar



# the description is used in the feed.xml file
description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features."
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 7a869d7

Please sign in to comment.