From 641c8bfab735c18cbc220ae0c22e69b50a56de1b Mon Sep 17 00:00:00 2001 From: Simon Sprankel Date: Fri, 5 Aug 2016 12:40:03 +0200 Subject: [PATCH] documentation skeleton with Jekyll documentation theme --- .gitignore | 5 + 404.md | 6 + Gemfile | 5 + Gemfile.lock | 128 + README.md | 1 + _config.yml | 84 + _data/alerts.yml | 15 + _data/sidebars/bi_sidebar.yml | 19 + _data/sidebars/ctp_sidebar.yml | 13 + _data/sidebars/home_sidebar.yml | 19 + _data/sidebars/otp_sidebar.yml | 13 + _data/strings.yml | 5 + _data/topnav.yml | 20 + _includes/archive.html | 15 + _includes/callout.html | 1 + _includes/custom/sidebarconfigs.html | 15 + _includes/disqus.html | 16 + _includes/feedback.html | 1 + _includes/footer.html | 9 + _includes/google_analytics.html | 6 + _includes/head.html | 36 + _includes/head_print.html | 33 + _includes/image.html | 1 + _includes/important.html | 1 + _includes/initialize_shuffle.html | 130 + _includes/inline_image.html | 1 + _includes/links.html | 44 + _includes/note.html | 1 + _includes/sidebar.html | 56 + _includes/taglogic.html | 32 + _includes/tip.html | 1 + _includes/toc.html | 21 + _includes/topnav.html | 75 + _includes/warning.html | 1 + _layouts/default.html | 80 + _layouts/default_print.html | 25 + _layouts/none.html | 3 + _layouts/page.html | 72 + _layouts/page_print.html | 15 + _layouts/post.html | 41 + css/bootstrap.min.css | 5 + css/customstyles.css | 1161 +++++ css/font-awesome.min.css | 4 + css/fonts/FontAwesome.otf | Bin 0 -> 93888 bytes css/fonts/fontawesome-webfont.eot | Bin 0 -> 60767 bytes css/fonts/fontawesome-webfont.svg | 565 +++ css/fonts/fontawesome-webfont.ttf | Bin 0 -> 122092 bytes css/fonts/fontawesome-webfont.woff | Bin 0 -> 71508 bytes css/fonts/fontawesome-webfont.woff2 | Bin 0 -> 56780 bytes css/lavish-bootstrap.css | 5898 ++++++++++++++++++++++ css/modern-business.css | 93 + css/printstyles.css | 160 + css/syntax.css | 60 + css/theme-blue.css | 103 + css/theme-green.css | 99 + feed.xml | 32 + fonts/FontAwesome.otf | Bin 0 -> 85908 bytes fonts/fontawesome-webfont.eot | Bin 0 -> 56006 bytes fonts/fontawesome-webfont.svg | 520 ++ fonts/fontawesome-webfont.ttf | Bin 0 -> 112160 bytes fonts/fontawesome-webfont.woff | Bin 0 -> 65452 bytes fonts/glyphicons-halflings-regular.eot | Bin 0 -> 20127 bytes fonts/glyphicons-halflings-regular.svg | 288 ++ fonts/glyphicons-halflings-regular.ttf | Bin 0 -> 45404 bytes fonts/glyphicons-halflings-regular.woff | Bin 0 -> 23424 bytes fonts/glyphicons-halflings-regular.woff2 | Bin 0 -> 18028 bytes images/company_logo.png | Bin 0 -> 9033 bytes images/company_logo_big.png | Bin 0 -> 18315 bytes images/favicon.ico | Bin 0 -> 12014 bytes index.md | 8 + js/customscripts.js | 55 + js/jekyll-search.js | 1 + js/jquery.ba-throttle-debounce.min.js | 9 + js/jquery.localScroll.min.js | 7 + js/jquery.navgoco.min.js | 8 + js/jquery.scrollTo.min.js | 7 + js/jquery.shuffle.min.js | 1588 ++++++ js/toc.js | 82 + licenses/LICENSE | 21 + licenses/LICENSE-BSD-NAVGOCO.txt | 27 + pages/bi/bi_index.md | 12 + pages/ctp/ctp_index.md | 8 + pages/otp/otp_index.md | 8 + search.json | 21 + sitemap.xml | 24 + 85 files changed, 11939 insertions(+) create mode 100644 .gitignore create mode 100644 404.md create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 _config.yml create mode 100644 _data/alerts.yml create mode 100644 _data/sidebars/bi_sidebar.yml create mode 100644 _data/sidebars/ctp_sidebar.yml create mode 100644 _data/sidebars/home_sidebar.yml create mode 100644 _data/sidebars/otp_sidebar.yml create mode 100644 _data/strings.yml create mode 100644 _data/topnav.yml create mode 100644 _includes/archive.html create mode 100644 _includes/callout.html create mode 100644 _includes/custom/sidebarconfigs.html create mode 100644 _includes/disqus.html create mode 100644 _includes/feedback.html create mode 100755 _includes/footer.html create mode 100644 _includes/google_analytics.html create mode 100644 _includes/head.html create mode 100644 _includes/head_print.html create mode 100644 _includes/image.html create mode 100644 _includes/important.html create mode 100644 _includes/initialize_shuffle.html create mode 100644 _includes/inline_image.html create mode 100644 _includes/links.html create mode 100644 _includes/note.html create mode 100644 _includes/sidebar.html create mode 100644 _includes/taglogic.html create mode 100644 _includes/tip.html create mode 100644 _includes/toc.html create mode 100644 _includes/topnav.html create mode 100644 _includes/warning.html create mode 100644 _layouts/default.html create mode 100644 _layouts/default_print.html create mode 100644 _layouts/none.html create mode 100644 _layouts/page.html create mode 100644 _layouts/page_print.html create mode 100644 _layouts/post.html create mode 100755 css/bootstrap.min.css create mode 100644 css/customstyles.css create mode 100644 css/font-awesome.min.css create mode 100644 css/fonts/FontAwesome.otf create mode 100644 css/fonts/fontawesome-webfont.eot create mode 100644 css/fonts/fontawesome-webfont.svg create mode 100644 css/fonts/fontawesome-webfont.ttf create mode 100644 css/fonts/fontawesome-webfont.woff create mode 100644 css/fonts/fontawesome-webfont.woff2 create mode 100644 css/lavish-bootstrap.css create mode 100755 css/modern-business.css create mode 100644 css/printstyles.css create mode 100644 css/syntax.css create mode 100644 css/theme-blue.css create mode 100644 css/theme-green.css create mode 100644 feed.xml create mode 100644 fonts/FontAwesome.otf create mode 100644 fonts/fontawesome-webfont.eot create mode 100644 fonts/fontawesome-webfont.svg create mode 100644 fonts/fontawesome-webfont.ttf create mode 100644 fonts/fontawesome-webfont.woff create mode 100644 fonts/glyphicons-halflings-regular.eot create mode 100644 fonts/glyphicons-halflings-regular.svg create mode 100644 fonts/glyphicons-halflings-regular.ttf create mode 100644 fonts/glyphicons-halflings-regular.woff create mode 100644 fonts/glyphicons-halflings-regular.woff2 create mode 100644 images/company_logo.png create mode 100644 images/company_logo_big.png create mode 100644 images/favicon.ico create mode 100644 index.md create mode 100644 js/customscripts.js create mode 100644 js/jekyll-search.js create mode 100644 js/jquery.ba-throttle-debounce.min.js create mode 100644 js/jquery.localScroll.min.js create mode 100755 js/jquery.navgoco.min.js create mode 100644 js/jquery.scrollTo.min.js create mode 100644 js/jquery.shuffle.min.js create mode 100644 js/toc.js create mode 100644 licenses/LICENSE create mode 100644 licenses/LICENSE-BSD-NAVGOCO.txt create mode 100644 pages/bi/bi_index.md create mode 100644 pages/ctp/ctp_index.md create mode 100644 pages/otp/otp_index.md create mode 100644 search.json create mode 100644 sitemap.xml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c28a8b0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +_site/ +.sass-cache/ +.jekyll-metadata +_pdf +.idea/ diff --git a/404.md b/404.md new file mode 100644 index 0000000..a7b58c0 --- /dev/null +++ b/404.md @@ -0,0 +1,6 @@ +--- +title: "Page Not Found" +search: exclude +--- + +Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct. diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..bf4e6d9 --- /dev/null +++ b/Gemfile @@ -0,0 +1,5 @@ +source "https://rubygems.org" + +# gem "rails" +gem 'github-pages' +gem 'jekyll' \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..a32518d --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,128 @@ +GEM + remote: https://rubygems.org/ + specs: + RedCloth (4.2.9) + activesupport (4.2.5.1) + i18n (~> 0.7) + json (~> 1.7, >= 1.7.7) + minitest (~> 5.1) + thread_safe (~> 0.3, >= 0.3.4) + tzinfo (~> 1.1) + addressable (2.3.8) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.10.0) + colorator (0.1) + ethon (0.8.1) + ffi (>= 1.3.0) + execjs (2.6.0) + faraday (0.9.2) + multipart-post (>= 1.2, < 3) + ffi (1.9.10) + gemoji (2.1.0) + github-pages (52) + RedCloth (= 4.2.9) + github-pages-health-check (= 1.0.1) + jekyll (= 3.0.3) + jekyll-coffeescript (= 1.0.1) + jekyll-feed (= 0.4.0) + jekyll-gist (= 1.4.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 (= 1.3.1) + jekyll-sitemap (= 0.10.0) + jekyll-textile-converter (= 0.1.0) + jemoji (= 0.5.1) + kramdown (= 1.9.0) + liquid (= 3.0.6) + mercenary (~> 0.3) + rdiscount (= 2.1.8) + redcarpet (= 3.3.3) + rouge (= 1.10.1) + terminal-table (~> 1.4) + 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.3) + colorator (~> 0.1) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 1.1) + kramdown (~> 1.3) + liquid (~> 3.0) + mercenary (~> 0.3.3) + rouge (~> 1.7) + safe_yaml (~> 1.0) + jekyll-coffeescript (1.0.1) + coffee-script (~> 2.2) + jekyll-feed (0.4.0) + jekyll-gist (1.4.0) + octokit (~> 4.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 (1.3.1) + jekyll (~> 3.0) + jekyll-sitemap (0.10.0) + jekyll-textile-converter (0.1.0) + RedCloth (~> 4.0) + jekyll-watch (1.3.1) + listen (~> 3.0) + jemoji (0.5.1) + gemoji (~> 2.0) + html-pipeline (~> 2.2) + jekyll (>= 2.0) + json (1.8.3) + kramdown (1.9.0) + liquid (3.0.6) + listen (3.0.6) + rb-fsevent (>= 0.9.3) + rb-inotify (>= 0.9.7) + mercenary (0.3.5) + mini_portile2 (2.0.0) + minitest (5.8.4) + multipart-post (2.0.0) + net-dns (0.8.0) + nokogiri (1.6.7.2) + mini_portile2 (~> 2.0.0.rc2) + octokit (4.2.0) + sawyer (~> 0.6.0, >= 0.5.3) + public_suffix (1.5.3) + rb-fsevent (0.9.7) + rb-inotify (0.9.7) + ffi (>= 0.5.0) + rdiscount (2.1.8) + redcarpet (3.3.3) + rouge (1.10.1) + safe_yaml (1.0.4) + sass (3.4.21) + sawyer (0.6.0) + addressable (~> 2.3.5) + faraday (~> 0.8, < 0.10) + terminal-table (1.5.2) + thread_safe (0.3.5) + typhoeus (0.8.0) + ethon (>= 0.8.0) + tzinfo (1.2.2) + thread_safe (~> 0.1) + +PLATFORMS + ruby + +DEPENDENCIES + github-pages + jekyll diff --git a/README.md b/README.md index 47f97d2..5896d5e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ # CustomGento Magento Extensions Documentation +http://docs.customgento.com diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..ffe8901 --- /dev/null +++ b/_config.yml @@ -0,0 +1,84 @@ + +output: web +# this property is useful for conditional filtering of content that is separate from the PDF. + +topnav_title: CustomGento Extension Documentation +# this appears on the top navigation bar next to the home button + +site_title: CustomGento Extension Documentation +# this appears in the html browser tab for the site title (seen mostly by search engines, not users) + +company_name: CustomGento - Simon Sprankel +# this appears in the footer + +github_editme_path: customgento/docs/blob/gh-pages/pages/ +# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. + +disqus_shortname: +# if you're using disqus for comments, add the shortname here. if not, leave this value blank. + +host: 127.0.0.1 +# the preview server used. Leave as is. + +port: 4005 +# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006. + +exclude: + - .idea/ + - .gitignore +# these are the files and directories that jekyll will exclude from the build + +feedback_subject_line: CustomGento Extension Documentation Feedback + +feedback_email: info@customgento.com +# used as a contact email for the Feedback link in the top navigation bar + +# feedback_disable: true +# if you uncomment the previous line, the Feedback link gets removed + +# feedback_text: "Need help?" +# if you uncomment the previous line, it changes the Feedback text + +# feedback_link: "http://helpy.io/" +# if you uncomment the previous line, it changes where the feedback link points to + +highlighter: rouge +# library used for syntax highlighting + +markdown: kramdown +kramdown: + input: GFM + auto_ids: true + hard_wrap: false + syntax_highlighter: rouge +# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways + +collections: + tooltips: + output: false +# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true + +defaults: + - + scope: + path: "" + type: "pages" + values: + layout: "page" + comments: true + search: true + sidebar: home_sidebar + +# these are defaults used for the frontmatter for these file types + +sidebars: +- home_sidebar +- ctp_sidebar +- bi_sidebar +- otp_sidebar + +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." +# the description is used in the feed.xml file + +# needed for sitemap.xml file only +url: http://docs.customgento.com diff --git a/_data/alerts.yml b/_data/alerts.yml new file mode 100644 index 0000000..157e162 --- /dev/null +++ b/_data/alerts.yml @@ -0,0 +1,15 @@ +tip: '