Skip to content

Commit

Permalink
first commit. uploaded theme files
Browse files Browse the repository at this point in the history
  • Loading branch information
tomjoht committed Jun 30, 2017
1 parent 03bd129 commit 3471cfd
Show file tree
Hide file tree
Showing 148 changed files with 28,019 additions and 3 deletions.
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
_site
.sass-cache
.jekyll-metadata
**/.DS_Store
.DS_Store
_output_ja
_output_de
jekyll-doc-project-*
jekyll-doc-project.gemspec
16 changes: 16 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Page Not Found
layout: default

type: 404
---

<p>Sorry, page not found. Please let us know about the broken link.</p>

<div class="searchForm404">
<form action="search.html" method="get">
<label for="search-box">Search</label>
<input type="text" id="search-box" name="query">
<input type="submit" value="search">
</form>
</div>
11 changes: 11 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
source "https://rubygems.org"

gem "jekyll"

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]


# when using the gem version of the theme, uncomment this:
gem "jekyll-doc-project"
gem 'jekyll', '~> 3.4', '>= 3.4.3'
5 changes: 4 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
Apache License
(Note: This site includes third party software subject varying copyrights. See NOTICE for details.)


Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

Expand Down
23 changes: 23 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

**********************
THIRD-PARTY COMPONENTS
**********************

This site includes third-party code subject to the following copyrights:

* Original theme from a Bootstrap Bootswatch fork: http://www.codeply.com/go/rV7KhUjwCN (MIT license)
* Bootstrap: http://themes.getbootstrap.com/pages/our-license (MIT license)
* jQuery: https://github.com/jquery/jquery/edit/master/LICENSE.txt (MIT license)
* Jekyll: https://github.com/jekyll/jekyll (MIT license)
* Navgoco sidebar: https://github.com/tefra/navgoco (BSD license)
* Anchor JS: https://github.com/bryanbraun/anchorjs/ (MIT license)
* Lunr.js: https://github.com/olivernn/lunr.js (MIT license)
* pygments-css (monokai.css) for code syntax highlighting: https://github.com/richleland/pygments-css (Unlicense)
* mojombo / tpw (syntax.css) for code syntax highlighting (Hippo theme): https://github.com/mojombo/tpw/blob/master/css/syntax.css (MIT license)
* Bootsnipp footer: http://bootsnipp.com/snippets/1KEEq (MIT license)
* TOC generator: https://github.com/ghiculescu/jekyll-table-of-contents (MIT license)
* FontAwesome: http://fontawesome.io/license/ (GPL)
* jQuery Cookie: https://github.com/carhartl/jquery-cookie (MIT license)
* jQuery inc-plugin. http://johannburkard.de/blog/programming/javascript/inc-a-super-tiny-client-side-include-javascript-jquery-plugin.html (MIT license).

NOTE: See the /assets/licenses folder for the license files required to be included by these third-party components.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# jekyll-doc-project
This repository contains an open-source Jekyll theme for authoring and publishing technical documentation. This theme is used by Appstore/Alexa tech writers and other community members. Most of the theme's files are stored in a Ruby Gem (called jekyll-doc-project).
## Jekyll Doc Project -- a theme for building documentation websites with Jekyll

This repo contains the Jekyll Doc Project theme, which is used for creating documentation projects with Jekyll. For information on getting started, see \_docs/jekyllhowto/Theme Instructions/jekyllhow-to-getting-started.md. The Theme Instructions folder contains all the documentation needed to work with this theme.
227 changes: 227 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,227 @@


############# SITE PROPERTIES #############
# title to appear in nav bar and page meta
title: Jekyll Doc Project theme

# the gem used for the project
# to see the gem files, type "bundle show jekyll-doc-project". the returned folder shows the _includes, _layouts, _sass, and assets folders used in the gem.
# you can overwrite any file by creating a similarly named file in your own project.
theme: jekyll-doc-project

# localhost port (can be anything)
port: 4000

# used with localization. change to "japanese" or "german" if localizing.
language: english

# the output. in the _config_pdf.yml, this is "pdf". you can create conditions based on this property (such as navtab content that should appear in web but not pdf).
format: web

# the little icon that appears in the browser window's tab
favicon: assets/favicon.ico

# appears in footer
copyright: 2017 Your Company, Inc.

############# TOP NAVIGATION BAR ################

# if you want to use a text title (the "title" property as defined above) instead of a logo image in your nav bar, comment out the logo below. Logo images are constrained at 50px in height.
logo: assets/companylogo.png

# make search bar appear in top nav?
search_in_topnav: true

# make search bar appear in sidebar?
search_in_sidebar: false

# in responsive view, show sidebar toggle button?
toggle-sidebar-button: true

# in responsive view, show navbar toggle button?
navbar-toggle: true


############# AUTOMATED LINKS #############

# the links.html script requires you to list your sidebars here. this is if you're using managed links (see jekyllhowto-content-and-formatting.html#automatedlinks)
sidebars:
- generic
- jekyllhowto

# determines whether the links.html script uses the jurl or hurl values in the sidebar data file
link_type: jurl

############# FEEDBACK BUTTON #############

# show feedback button in top nav bar?
show_feedback: true

# name of Feedback link
feedback_link_name: Feedback

# email address feedback gets sent to
feedback_email: [email protected]

# Auto-filled Subject link of email
feedback_subject_line: Feedback about docs

# note: to customize the auto-completed body text, overwrite it by adding _includes/feedback.html in your own theme.


############# GITHUB BUTTON #############

# inserts github link in top nav bar (recommended)
github_button_location_top_navbar: true

# inserts github link below page title
github_button_location_below_title: false

# inserts github link at bottom of page (least visible)
github_button_location_page_bottom: false

# text for github button
github_edit_button_text: Edit on GitHub

# link to your github repo. replace <organization> (if applicable) and <repo name> and <branch name>. Note that the github link will be {{site.github_editme_path}}/{{page.path}}
github_editme_path: https://github.com/<organization>/<repo name>/blob/<branch name>


############# EXCLUDE LIST #############
# these folders or files will not be included in the output. you can use wildcards with asterisks.
exclude:
- Config
- s3_website
- _config_*
- Gemfile*
- serve_*
- build_*
- gem_*
- prince-list.txt
- jekyll-doc-project*

############# IMAGE PATHS #############

# if you want the images to be prefaced with a specific path, insert it here. Don't include a trailing slash at the end.
# the image include will insert this path before the image file name and will also add a /.
image_path: images
audio_path: audio


############# CLOUD STORAGE PATH #############

# most users can ignore this. if you have a layout that references assets on the cloud, you can store the asset path here.
cloud_storage_path: https://images-na.ssl-images-company.com/images/G/01/mobile-apps


############# DEFAULTS #############
# you can define default frontmatter values here. you can narrow the type down with subfolders (e.g., docs/myfolder).
# you might want to list your sidebar and product as default frontmatter values
# with translation, change topnav, footer (and sidebar) to use topnav_ja, footer_ja, generic_ja etc. for Japanese, or _de for german. you must have corresponding
# data files with those _ja or _de file names. Read more in jekyllhowto-localization.html.
defaults:
-
scope:
path: ""
type: pages
values:
layout: default
topnav: topnav
footer: footer
-
scope:
path: ""
type: docs
values:
layout: default
topnav: topnav
footer: footer

-
scope:
path: ""
type: search
values:
layout: default
topnav: topnav
type: search
footer: footer
-
scope:
path: "images"
values:
image: true

############# COMMENTS #############
# show Disqus comments after pages
show_disqus_comments: false

# shortname for configuring Disqus
disqus_shortname:

############# GOOGLE ANALYTICS #############

# include Google Analytics?
show_google_analytics: false

# Google Analytics tracking code number (not the whole code snippet -- just UA-123456 or so)
# To adjust the google analytics code snippet, see the _includes/google_analytics.html code in the gem
google_analytics_code:

############# Breadcrumb ############
# you can modify the breadcrumb in _includes/breadcrumb.html

# Display breadcrumbs at all?
breadcrumb_display: true

# Display Home path in breadcrumb?
breadcrumb_home_display: true

# Url for Home path to point to
breadcrumb_home_url: http://yourcompanysite.com

# Display name for "Home" path
breadcrumb_home_name: Home

########## UI text ###############
# The UI text is separated into strings defined here to facilitate translation. Translate these for Japanese and German outputs.
# Some other strings (for Github and Feedback buttons) appear in the related sections in this _config.yml file

uistring:
tableofcontents: Table of Contents
log_doc_issue: Log Doc Issue
expandall: Expand All
collapseall: Collapse All
title: User Guide # Displays as site title on top nav bar and on site metadata
description: Description of the site # Displays as site description meta
search_placeholder_product: Search ...
search_results_page_title: Search results
search_no_results_found: No results found.
products: Products
docindex_product: Product
docindex_startpage: Starting page


########## MARKDOWN PROCESS AND FILTER ##########
# leave these settings as is unless you want to use something other than kramdown Markdown

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

########## SASS SETTINGS ##########
# used to define sass settings. leave as is.

sass:
style: compressed

############# COLLECTIONS #############
# used to define collections used in project. leave as is.

collections:
docs:
output: true
60 changes: 60 additions & 0 deletions _config_pdf_jekyllhowto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
######## Customize these Values ##########
print_title: "Jekyll How-to Guide"
print_subtitle: Version 1.0
sidebar: jekyllhowto
folder_path: /Users/tomjoht/projects/multioutput/Devcomm-jekyll-doc-project/_site
title_page_image: docs/jekyllhowto/images/company_logo_big.png
copyright_notice: >
This is the copyright notice...
########


############# Sidebars Used #############
sidebars:
- generic
- jekyllhowto

language: english
target: jekyll
format: pdf

destination: _site
port: 4000
highlighter: rouge
exclude:
- mobi
- pdf

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

collections:
docs:
output: true

sass:
style: compressed

defaults:
-
scope:
path: ""
type: pages
values:
layout: printpdf
-
scope:
path: ""
type: docs
values:
layout: printpdf

image_type: a
image_path: docs
audio_path: docs

site_type: jekyll
Loading

0 comments on commit 3471cfd

Please sign in to comment.