add docs/ to generate github page
This commit is contained in:
Mahmoud Zalt
15
docs/_data/alerts.yml
Executable file
15
docs/_data/alerts.yml
Executable file
@ -0,0 +1,15 @@
|
||||
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>'
|
||||
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"/>'
|
||||
9
docs/_data/definitions.yml
Executable file
9
docs/_data/definitions.yml
Executable file
@ -0,0 +1,9 @@
|
||||
elephant: "This is a sample definition."
|
||||
|
||||
baseball: "Baseball is considered America's pasttime sport, though that may be more of a historical term than a current one. There's a lot more excitement about football than baseball. A baseball game is somewhat of a snooze to watch, for the most part."
|
||||
|
||||
basketball: "Basketball is a sport involving two teams of five players each competing to put a ball through a small circular rim 10 feet above the ground. Basketball requires players to be in top physical condition, since they spend most of the game running back and forth along a 94-foot-long floor."
|
||||
|
||||
football: "No doubt the most fun sport to watch, football also manages to accrue the most injuries with the players. From concussions to blown knees, football players have short sport lives."
|
||||
|
||||
soccer: "If there's one sport that dominates the world landscape, it's soccer. However, US soccer fans are few and far between. Apart from the popularity of soccer during the World Cup, most people don't even know the name of the professional soccer organization in their area."
|
||||
11
docs/_data/glossary.yml
Executable file
11
docs/_data/glossary.yml
Executable file
@ -0,0 +1,11 @@
|
||||
jekyll_platform: "Jekyll is a static site generator that builds sites using most modern web technologies."
|
||||
|
||||
fractious: "Like a little mischevious child, full of annoying and constant trouble."
|
||||
|
||||
gratuitous: "Something that is unwarranted and uncouth, like the social equivalent of a flagrant foul."
|
||||
|
||||
haughty: "Proud and flaunting it. Holding your head high up like a snooty, too-good-for-everything rich person."
|
||||
|
||||
impertinent: "Someone acting rude and insensitive to others."
|
||||
|
||||
intrepid: "Brave and courageous especially in a difficult, dangerous situation."
|
||||
107
docs/_data/samplelist.yml
Executable file
107
docs/_data/samplelist.yml
Executable file
@ -0,0 +1,107 @@
|
||||
entries:
|
||||
- title: Sidebar
|
||||
folders:
|
||||
- title: Food
|
||||
|
||||
folderitems:
|
||||
- title: Bananas
|
||||
url: bananas.html
|
||||
|
||||
subfolder:
|
||||
- title: Apples
|
||||
|
||||
subfolderitems:
|
||||
- title: Fuji apples
|
||||
url: fuji_apples.html
|
||||
|
||||
|
||||
- title: Gala apples
|
||||
url: gala_apples.html
|
||||
|
||||
name:
|
||||
husband: Tom
|
||||
wife: Shannon
|
||||
|
||||
bikes:
|
||||
- title: mountain bikes
|
||||
- title: road bikes
|
||||
- title: hybrid bikes
|
||||
|
||||
|
||||
salesteams:
|
||||
- title: Regions
|
||||
subfolderitems:
|
||||
- location: US
|
||||
- location: Spain
|
||||
- location: France
|
||||
|
||||
toc:
|
||||
- title: Group 1
|
||||
subfolderitems:
|
||||
- page: Thing 1
|
||||
- page: Thing 2
|
||||
- page: Thing 3
|
||||
- title: Group 2
|
||||
subfolderitems:
|
||||
- page: Piece 1
|
||||
- page: Piece 2
|
||||
- page: Piece 3
|
||||
- title: Group 3
|
||||
subfolderitems:
|
||||
- page: Widget 1
|
||||
- page: Widget 2
|
||||
- page: Widget 3
|
||||
|
||||
something: &hello Greetings earthling!
|
||||
myref: *hello
|
||||
|
||||
about:
|
||||
- zero
|
||||
- one
|
||||
- two
|
||||
- three
|
||||
|
||||
numbercolors:
|
||||
- zero:
|
||||
properties: red
|
||||
- one:
|
||||
properties: yellow
|
||||
- two:
|
||||
properties: green
|
||||
- three:
|
||||
properties: blue
|
||||
|
||||
mypages:
|
||||
- section1: Section 1
|
||||
audience: developers
|
||||
product: acme
|
||||
url: facebook.com
|
||||
- section2: Section 2
|
||||
audience: writers
|
||||
product: acme
|
||||
url: google.com
|
||||
- section3: Section 3
|
||||
audience: developers
|
||||
product: acme
|
||||
url: amazon.com
|
||||
- section4: Section 4
|
||||
audience: writers
|
||||
product: gizmo
|
||||
url: apple.com
|
||||
- section5: Section 5
|
||||
audience: writers
|
||||
product: acme
|
||||
url: microsoft.com
|
||||
|
||||
feedback: >
|
||||
This is my feedback to you.
|
||||
Even if I include linebreaks here,
|
||||
all of the linebreaks will be removed when the value is inserted.
|
||||
|
||||
block: |
|
||||
This pipe does something a little different.
|
||||
It preserves the breaks.
|
||||
This is really helpful for code samples,
|
||||
since you can format the code samples with
|
||||
the appropriate
|
||||
white spacing.
|
||||
22
docs/_data/sidebars/home_sidebar.yml
Executable file
22
docs/_data/sidebars/home_sidebar.yml
Executable file
@ -0,0 +1,22 @@
|
||||
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
|
||||
|
||||
entries:
|
||||
- title: Sidebar
|
||||
levels: one
|
||||
folders:
|
||||
|
||||
- title: Products
|
||||
output: web
|
||||
folderitems:
|
||||
- title: News
|
||||
url: /news.html
|
||||
output: web
|
||||
- title: Theme instructions
|
||||
url: /mydoc_introduction.html
|
||||
output: web
|
||||
- title: Product 1
|
||||
url: /p1_landing_page.html
|
||||
output: web
|
||||
- title: Product 2
|
||||
url: /p2_landing_page.html
|
||||
output: web
|
||||
303
docs/_data/sidebars/mydoc_sidebar.yml
Executable file
303
docs/_data/sidebars/mydoc_sidebar.yml
Executable file
@ -0,0 +1,303 @@
|
||||
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
|
||||
|
||||
entries:
|
||||
- title: sidebar
|
||||
product: Jekyll Doc Theme
|
||||
version: 6.0
|
||||
folders:
|
||||
|
||||
- title:
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
folderitems:
|
||||
- title:
|
||||
url: /titlepage
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
- title:
|
||||
url: /tocpage
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
|
||||
- title: Overview
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
|
||||
- title: Get started
|
||||
url: /index.html
|
||||
output: web, pdf
|
||||
type: homepage
|
||||
|
||||
- title: Introduction
|
||||
url: /mydoc_introduction.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Supported features
|
||||
url: /mydoc_supported_features.html
|
||||
output: web, pdf
|
||||
|
||||
- title: About the theme author
|
||||
url: /mydoc_about.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Support
|
||||
url: /mydoc_support.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Release Notes
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
|
||||
- title: 6.0 Release notes
|
||||
url: /mydoc_release_notes_60.html
|
||||
output: web, pdf
|
||||
|
||||
- title: 5.0 Release notes
|
||||
url: /mydoc_release_notes_50.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Installation
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
|
||||
- title: About Ruby, Gems, Bundler, etc.
|
||||
url: /mydoc_about_ruby_gems_etc.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Install Jekyll on Mac
|
||||
url: /mydoc_install_jekyll_on_mac.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Install Jekyll on Windows
|
||||
url: /mydoc_install_jekyll_on_windows.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Authoring
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Pages
|
||||
url: /mydoc_pages.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Posts
|
||||
url: /mydoc_posts.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Lists
|
||||
url: /mydoc_lists.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Conditional logic
|
||||
url: /mydoc_conditional_logic.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Content reuse
|
||||
url: /mydoc_content_reuse.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Collections
|
||||
url: /mydoc_collections.html
|
||||
output: web, pdf
|
||||
|
||||
- title: WebStorm editor tips
|
||||
url: /mydoc_webstorm_text_editor.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Atom editor tips
|
||||
url: /mydoc_atom_text_editor.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Navigation
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Sidebar navigation
|
||||
url: /mydoc_sidebar_navigation.html
|
||||
output: web, pdf
|
||||
|
||||
- title: YAML tutorial in the context of Jekyll
|
||||
url: /mydoc_yaml_tutorial.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Tags
|
||||
url: /mydoc_tags.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Series
|
||||
url: /mydoc_series.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Formatting
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Tooltips
|
||||
url: /mydoc_adding_tooltips.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Alerts
|
||||
url: /mydoc_alerts.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Icons
|
||||
url: /mydoc_icons.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Images
|
||||
url: /mydoc_images.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Code samples
|
||||
url: /mydoc_code_samples.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Labels
|
||||
url: /mydoc_labels.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Links
|
||||
url: /mydoc_hyperlinks.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Navtabs
|
||||
url: /mydoc_navtabs.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Tables
|
||||
url: /mydoc_tables.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Syntax highlighting
|
||||
url: /mydoc_syntax_highlighting.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Workflow maps
|
||||
url: /mydoc_workflow_maps.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Handling reviews
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Commenting on files
|
||||
url: /mydoc_commenting_on_files.html
|
||||
output: web, pdf
|
||||
|
||||
# - title: Git collaboration
|
||||
# url: /mydoc_git_collaboration
|
||||
# output: web, pdf
|
||||
|
||||
- title: Publishing
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Build arguments
|
||||
url: /mydoc_build_arguments.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Themes
|
||||
url: /mydoc_themes.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Generating PDFs
|
||||
url: /mydoc_generating_pdfs.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Help APIs and UI tooltips
|
||||
url: /mydoc_help_api.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Search configuration
|
||||
url: /mydoc_search_configuration.html
|
||||
output: web, pdf
|
||||
|
||||
- title: iTerm profiles
|
||||
url: /mydoc_iterm_profiles.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Pushing builds to server
|
||||
url: /mydoc_push_build_to_server.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Getting around the password prompts in SCP
|
||||
url: /mydoc_no_password_prompts_scp.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Publishing on Github Pages
|
||||
url: /mydoc_publishing_github_pages.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Special layouts
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Knowledge-base layout
|
||||
url: /mydoc_kb_layout.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Glossary layout
|
||||
url: /mydoc_glossary.html
|
||||
output: web, pdf
|
||||
|
||||
- title: FAQ layout
|
||||
url: /mydoc_faq_layout.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Scroll layout
|
||||
url: /mydoc_scroll.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Shuffle layout
|
||||
url: /mydoc_shuffle.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Troubleshooting
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
|
||||
- title: Troubleshooting
|
||||
url: /mydoc_troubleshooting.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Tag archives
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Tag archives overview
|
||||
url: /mydoc_tag_archives_overview.html
|
||||
output: web
|
||||
|
||||
subfolders:
|
||||
- title: Tag archive pages
|
||||
output: web
|
||||
subfolderitems:
|
||||
|
||||
- title: Formatting pages
|
||||
url: /tag_formatting.html
|
||||
output: web
|
||||
|
||||
- title: Navigation pages
|
||||
url: /tag_navigation.html
|
||||
output: web
|
||||
|
||||
- title: Content types pages
|
||||
url: /tag_content_types.html
|
||||
output: web
|
||||
|
||||
- title: Publishing pages
|
||||
url: /tag_publishing.html
|
||||
output: web
|
||||
|
||||
- title: Special layout pages
|
||||
url: /tag_special_layouts.html
|
||||
output: web
|
||||
|
||||
- title: Collaboration pages
|
||||
url: /tag_collaboration.html
|
||||
output: web
|
||||
|
||||
- title: Troubleshooting pages
|
||||
url: /tag_troubleshooting.html
|
||||
output: web
|
||||
18
docs/_data/sidebars/other.yml
Executable file
18
docs/_data/sidebars/other.yml
Executable file
@ -0,0 +1,18 @@
|
||||
|
||||
# Follow the pattern here for the URLs -- no slash at the beginning, and include the .html. The link here is rendered exactly as is in the Markdown references.
|
||||
|
||||
entries:
|
||||
- title: other
|
||||
folders:
|
||||
|
||||
- title: Other Links
|
||||
folderitems:
|
||||
|
||||
- title: Automated links bookmark
|
||||
url: /mydoc_hyperlinks.html#automatedlinks
|
||||
|
||||
- title: Bookmark links
|
||||
url: /mydoc_hyperlinks.html#bookmarklinks
|
||||
|
||||
- title: Some link bookmark
|
||||
url: /mydoc_pages.html#someIdTag
|
||||
60
docs/_data/sidebars/product1_sidebar.yml
Executable file
60
docs/_data/sidebars/product1_sidebar.yml
Executable file
@ -0,0 +1,60 @@
|
||||
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
|
||||
|
||||
|
||||
entries:
|
||||
- title: Sidebar
|
||||
product: Product1
|
||||
version: 1.0
|
||||
folders:
|
||||
|
||||
- title:
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
folderitems:
|
||||
- title:
|
||||
url: /titlepage
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
- title:
|
||||
url: /tocpage
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
|
||||
- title: Getting Started
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
- title: Product 1 home
|
||||
url: /p1_landing_page.html
|
||||
output: web
|
||||
|
||||
- title: Sample 1
|
||||
url: /p1_sample1.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 2
|
||||
url: /p1_sample2.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 3
|
||||
url: /p1_sample3.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Another heading
|
||||
output: web, pdf
|
||||
|
||||
folderitems:
|
||||
- title: Sample 4
|
||||
url: /p1_sample4.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 5
|
||||
url: /p1_sample5.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 6
|
||||
url: /p1_sample6.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 7
|
||||
url: /p1_sample7.html
|
||||
output: web, pdf
|
||||
92
docs/_data/sidebars/product2_sidebar.yml
Executable file
92
docs/_data/sidebars/product2_sidebar.yml
Executable file
@ -0,0 +1,92 @@
|
||||
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
|
||||
|
||||
entries:
|
||||
- title: Product2
|
||||
product: Product2
|
||||
version: 1.0
|
||||
folders:
|
||||
|
||||
- title:
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
folderitems:
|
||||
- title:
|
||||
url: /titlepage
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
- title:
|
||||
url: /tocpage
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
|
||||
- title: Introduction
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
|
||||
- title: Overview
|
||||
url: /p2_landing_page.html
|
||||
output: web
|
||||
|
||||
- title: Simple Workflow
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
|
||||
- title: Sample 1
|
||||
url: /p2_sample1.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 2
|
||||
url: /p2_sample2.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 3
|
||||
url: /p2_sample3.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 4
|
||||
url: /p2_sample4.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 5
|
||||
url: /p2_sample5.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Complex Workflow
|
||||
output: web, pdf
|
||||
folderitems:
|
||||
|
||||
- title: Sample 6
|
||||
url: /p2_sample6.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 7
|
||||
url: /p2_sample7.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 8
|
||||
url: /p2_sample8.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 9
|
||||
url: /p2_sample9.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 10
|
||||
url: /p2_sample10.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 11
|
||||
url: /p2_sample11.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 12
|
||||
url: /p2_sample12.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 13
|
||||
url: /p2_sample13.html
|
||||
output: web, pdf
|
||||
|
||||
- title: Sample 14
|
||||
url: /p2_sample14.html
|
||||
output: web, pdf
|
||||
5
docs/_data/strings.yml
Executable file
5
docs/_data/strings.yml
Executable file
@ -0,0 +1,5 @@
|
||||
|
||||
|
||||
# placed here for translation purposes
|
||||
search_placeholder_text: search...
|
||||
search_no_results_text: No results found.
|
||||
12
docs/_data/tags.yml
Executable file
12
docs/_data/tags.yml
Executable file
@ -0,0 +1,12 @@
|
||||
allowed-tags:
|
||||
- getting_started
|
||||
- content_types
|
||||
- navigation
|
||||
- formatting
|
||||
- publishing
|
||||
- single_sourcing
|
||||
- special_layouts
|
||||
- collaboration
|
||||
- news
|
||||
- troubleshooting
|
||||
- mobile
|
||||
1
docs/_data/terms.yml
Executable file
1
docs/_data/terms.yml
Executable file
@ -0,0 +1 @@
|
||||
apple: "apple - the fruit of a disiduous tree."
|
||||
32
docs/_data/topnav.yml
Executable file
32
docs/_data/topnav.yml
Executable file
@ -0,0 +1,32 @@
|
||||
## Topnav single links
|
||||
## if you want to list an external url, use external_url instead of url. the theme will apply a different link base.
|
||||
topnav:
|
||||
- title: Topnav
|
||||
items:
|
||||
- title: News
|
||||
url: /news
|
||||
|
||||
#Topnav dropdowns
|
||||
topnav_dropdowns:
|
||||
- title: Topnav dropdowns
|
||||
folders:
|
||||
- title: Jekyll Resources
|
||||
folderitems:
|
||||
- title: Github Repo
|
||||
external_url: https://github.com/tomjohnson1492/documentation-theme-jekyll
|
||||
- title: Jekyll Talk
|
||||
external_url: https://talk.jekyllrb.com
|
||||
- title: Jekyll documentation
|
||||
external_url: http://jekyllrb.com/docs/home/
|
||||
- title: Jekyll on Stack Overflow
|
||||
external_url: http://stackoverflow.com/questions/tagged/jekyll
|
||||
- title: Jekyll on my blog
|
||||
external_url: http://idratherbewriting.com/category-jekyll/
|
||||
- title: Products
|
||||
folderitems:
|
||||
- title: Jekyll Documentation Theme
|
||||
url: /mydoc_introduction.html
|
||||
- title: Product 1
|
||||
url: /p1_landing_page.html
|
||||
- title: Product 2
|
||||
url: /p2_landing_page.html
|
||||
Reference in New Issue
Block a user