Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adireddy committed Mar 22, 2016
1 parent 6333726 commit 51dc57e
Show file tree
Hide file tree
Showing 153 changed files with 14,788 additions and 0 deletions.
6 changes: 6 additions & 0 deletions 404.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Page Not Found"
search: exclude
---

Sorry, but the page you were trying to view does not exist — perhaps you can try searching for it.
78 changes: 78 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# project definitions
project: docs
output: web
destination: doc_outputs/haxe-checkstyle/
topnav_title: Haxe Checkstyle Documentation
homepage_title:
site_title: Haxe Checkstyle Documentation
url: http://haxecheckstyle.github.io/haxe-checkstyle/
project_folder: docs
company_name: Gamesys
footer_image_location: common_images/company_logo.png
# variables


sidebar_tagline:
sidebar_version:
theme_file: theme-orange.css

# the algolia entries here are experimental only.

#gems:
# - algoliasearch-jekyll
#algolia:
# application_id: 'HXUBJERYYB'
# index_name: 'documentation_theme_jekyll_superslick'
port: 4009

exclude:
- _site
- _drafts
- configs/
- doc/docs*
- node_modules
- .temp
- .idea
- .n

# same for all
host: 127.0.0.1

# 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: rouge
markdown: kramdown
redcarpet:
extensions: ["no_intra_emphasis", "fenced_code_blocks", "tables", "with_toc_data"]

collections:
tooltips:
output: false

defaults:
-
scope:
path: ""
type: "pages"
values:
layout: "page"
comments: true
search: true
-
scope:
path: ""
type: "tooltips"
values:
layout: "page"
comments: true
search: true
tooltip: true

16 changes: 16 additions & 0 deletions _data/alerts.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
tip: '<div class="alert alert-success" role="alert"><i class="fa fa-check-square-o"></i> <b>Tip: </b>'
note: '<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note: </b>'
important: '<div class="alert alert-warning" role="alert"><i class="fa fa-warning"></i> <b>Important: </b>'
warning: '<div class="alert alert-danger" role="alert"><i class="fa fa-exclamation-circle"></i> <b>Warning: </b>'
error: '<div class="alert alert-danger" role="alert"><i class="fa fa-exclamation-circle"></i>'
end: '</div>'

callout_danger: '<div class="bs-callout bs-callout-danger">'
callout_default: '<div class="bs-callout bs-callout-default">'
callout_primary: '<div class="bs-callout bs-callout-primary">'
callout_success: '<div class="bs-callout bs-callout-success">'
callout_info: '<div class="bs-callout bs-callout-info">'
callout_warning: '<div class="bs-callout bs-callout-warning">'

hr_faded: '<hr class="faded"/>'
hr_shaded: '<hr class="shaded"/>'
76 changes: 76 additions & 0 deletions _data/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# project definitions
project: docs
audience: superslick
product: doc
platform: all
version: all
output: web
destination: ../doc_outputs/
topnav_title: Haxe Checkstyle Documentation
homepage_title:
site_title: Haxe Checkstyle Documentation
project_folder: docs
company_name: Gamesys
footer_image_location: ../../common_images/company_logo.png
# variables


sidebar_tagline:
sidebar_version:
theme_file: theme-green.css

# the algolia entries here are experimental only.

#gems:
# - algoliasearch-jekyll
#algolia:
# application_id: 'HXUBJERYYB'
# index_name: 'documentation_theme_jekyll_superslick'
port: 4009

exclude:
- _site
- _drafts
- configs/

# same for all
host: 127.0.0.1

# 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: rouge
markdown: kramdown
redcarpet:
extensions: ["no_intra_emphasis", "fenced_code_blocks", "tables", "with_toc_data"]

collections:
tooltips:
output: false

defaults:
-
scope:
path: ""
type: "pages"
values:
layout: "page"
comments: false
search: true
-
scope:
path: ""
type: "tooltips"
values:
layout: "page"
comments: false
search: true
tooltip: true

1 change: 1 addition & 0 deletions _data/docs/docs_definitions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
test: "This is a sample definition."
1 change: 1 addition & 0 deletions _data/docs/docs_glossary.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
jekyll_platform: "Jekyll is a static site generator that builds sites using most modern web technologies."
Loading

0 comments on commit 51dc57e

Please sign in to comment.