diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 000000000..ef2b79e3a --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,5 @@ +# Code Owners File +# Each Line is a pattern followed by one or more owners + +# Default owners +* @gunnydelight \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index ba4e04593..894b16c2c 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,248 +1,282 @@ GEM remote: https://rubygems.org/ specs: - activesupport (4.2.11.1) - i18n (~> 0.7) - minitest (~> 5.1) - thread_safe (~> 0.3, >= 0.3.4) - tzinfo (~> 1.1) - addressable (2.6.0) - public_suffix (>= 2.0.2, < 4.0) + activesupport (7.2.1) + base64 + bigdecimal + concurrent-ruby (~> 1.0, >= 1.3.1) + connection_pool (>= 2.2.5) + drb + i18n (>= 1.6, < 2) + logger (>= 1.4.2) + minitest (>= 5.1) + securerandom (>= 0.3) + tzinfo (~> 2.0, >= 2.0.5) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + base64 (0.2.0) + bigdecimal (3.1.8) coffee-script (2.4.1) coffee-script-source execjs - coffee-script-source (1.11.1) + coffee-script-source (1.12.2) colorator (1.1.0) - commonmarker (0.17.13) - ruby-enum (~> 0.5) - concurrent-ruby (1.1.5) - dnsruby (1.61.2) - addressable (~> 2.5) - em-websocket (0.5.1) + commonmarker (0.23.10) + concurrent-ruby (1.3.4) + connection_pool (2.4.1) + csv (3.3.0) + dnsruby (1.72.2) + simpleidn (~> 0.2.1) + drb (2.2.1) + em-websocket (0.5.3) eventmachine (>= 0.12.9) - http_parser.rb (~> 0.6.0) - ethon (0.12.0) - ffi (>= 1.3.0) + http_parser.rb (~> 0) + ethon (0.16.0) + ffi (>= 1.15.0) eventmachine (1.2.7) - execjs (2.7.0) - faraday (0.15.4) - multipart-post (>= 1.2, < 3) - ffi (1.11.1) + eventmachine (1.2.7-x64-mingw32) + eventmachine (1.2.7-x86-mingw32) + execjs (2.9.1) + faraday (2.12.0) + faraday-net_http (>= 2.0, < 3.4) + json + logger + faraday-net_http (3.3.0) + net-http + ffi (1.17.0) forwardable-extended (2.6.0) - gemoji (3.0.1) - github-pages (198) - activesupport (= 4.2.11.1) - github-pages-health-check (= 1.16.1) - jekyll (= 3.8.5) - jekyll-avatar (= 0.6.0) - jekyll-coffeescript (= 1.1.1) - jekyll-commonmark-ghpages (= 0.1.5) - jekyll-default-layout (= 0.1.4) - jekyll-feed (= 0.11.0) + gemoji (4.1.0) + github-pages (232) + github-pages-health-check (= 1.18.2) + jekyll (= 3.10.0) + jekyll-avatar (= 0.8.0) + jekyll-coffeescript (= 1.2.2) + jekyll-commonmark-ghpages (= 0.5.1) + jekyll-default-layout (= 0.1.5) + jekyll-feed (= 0.17.0) jekyll-gist (= 1.5.0) - jekyll-github-metadata (= 2.12.1) - jekyll-mentions (= 1.4.1) - jekyll-optional-front-matter (= 0.3.0) + jekyll-github-metadata (= 2.16.1) + jekyll-include-cache (= 0.2.1) + jekyll-mentions (= 1.6.0) + jekyll-optional-front-matter (= 0.3.2) jekyll-paginate (= 1.1.0) - jekyll-readme-index (= 0.2.0) - jekyll-redirect-from (= 0.14.0) - jekyll-relative-links (= 0.6.0) - jekyll-remote-theme (= 0.3.1) + jekyll-readme-index (= 0.3.0) + jekyll-redirect-from (= 0.16.0) + jekyll-relative-links (= 0.6.1) + jekyll-remote-theme (= 0.4.3) jekyll-sass-converter (= 1.5.2) - jekyll-seo-tag (= 2.5.0) - jekyll-sitemap (= 1.2.0) - jekyll-swiss (= 0.4.0) - jekyll-theme-architect (= 0.1.1) - jekyll-theme-cayman (= 0.1.1) - jekyll-theme-dinky (= 0.1.1) - jekyll-theme-hacker (= 0.1.1) - jekyll-theme-leap-day (= 0.1.1) - jekyll-theme-merlot (= 0.1.1) - jekyll-theme-midnight (= 0.1.1) - jekyll-theme-minimal (= 0.1.1) - jekyll-theme-modernist (= 0.1.1) - jekyll-theme-primer (= 0.5.3) - jekyll-theme-slate (= 0.1.1) - jekyll-theme-tactile (= 0.1.1) - jekyll-theme-time-machine (= 0.1.1) - jekyll-titles-from-headings (= 0.5.1) - jemoji (= 0.10.2) - kramdown (= 1.17.0) - liquid (= 4.0.0) - listen (= 3.1.5) + jekyll-seo-tag (= 2.8.0) + jekyll-sitemap (= 1.4.0) + jekyll-swiss (= 1.0.0) + jekyll-theme-architect (= 0.2.0) + jekyll-theme-cayman (= 0.2.0) + jekyll-theme-dinky (= 0.2.0) + jekyll-theme-hacker (= 0.2.0) + jekyll-theme-leap-day (= 0.2.0) + jekyll-theme-merlot (= 0.2.0) + jekyll-theme-midnight (= 0.2.0) + jekyll-theme-minimal (= 0.2.0) + jekyll-theme-modernist (= 0.2.0) + jekyll-theme-primer (= 0.6.0) + jekyll-theme-slate (= 0.2.0) + jekyll-theme-tactile (= 0.2.0) + jekyll-theme-time-machine (= 0.2.0) + jekyll-titles-from-headings (= 0.5.3) + jemoji (= 0.13.0) + kramdown (= 2.4.0) + kramdown-parser-gfm (= 1.1.0) + liquid (= 4.0.4) mercenary (~> 0.3) - minima (= 2.5.0) - nokogiri (>= 1.8.5, < 2.0) - rouge (= 2.2.1) + minima (= 2.5.1) + nokogiri (>= 1.16.2, < 2.0) + rouge (= 3.30.0) terminal-table (~> 1.4) - github-pages-health-check (1.16.1) + webrick (~> 1.8) + github-pages-health-check (1.18.2) addressable (~> 2.3) dnsruby (~> 1.60) - octokit (~> 4.0) - public_suffix (~> 3.0) + octokit (>= 4, < 8) + public_suffix (>= 3.0, < 6.0) typhoeus (~> 1.3) - html-pipeline (2.11.0) + html-pipeline (2.14.3) activesupport (>= 2) nokogiri (>= 1.4) - http_parser.rb (0.6.0) - i18n (0.9.5) + http_parser.rb (0.8.0) + i18n (1.14.6) concurrent-ruby (~> 1.0) - jekyll (3.8.5) + jekyll (3.10.0) addressable (~> 2.4) colorator (~> 1.0) + csv (~> 3.0) em-websocket (~> 0.5) - i18n (~> 0.7) + i18n (>= 0.7, < 2) jekyll-sass-converter (~> 1.0) jekyll-watch (~> 2.0) - kramdown (~> 1.14) + kramdown (>= 1.17, < 3) liquid (~> 4.0) mercenary (~> 0.3.3) pathutil (~> 0.9) rouge (>= 1.7, < 4) safe_yaml (~> 1.0) - jekyll-avatar (0.6.0) - jekyll (~> 3.0) - jekyll-coffeescript (1.1.1) + webrick (>= 1.0) + jekyll-avatar (0.8.0) + jekyll (>= 3.0, < 5.0) + jekyll-coffeescript (1.2.2) coffee-script (~> 2.2) - coffee-script-source (~> 1.11.1) - jekyll-commonmark (1.3.1) - commonmarker (~> 0.14) + coffee-script-source (~> 1.12) + jekyll-commonmark (1.4.0) + commonmarker (~> 0.22) + jekyll-commonmark-ghpages (0.5.1) + commonmarker (>= 0.23.7, < 1.1.0) + jekyll (>= 3.9, < 4.0) + jekyll-commonmark (~> 1.4.0) + rouge (>= 2.0, < 5.0) + jekyll-default-layout (0.1.5) + jekyll (>= 3.0, < 5.0) + jekyll-feed (0.17.0) jekyll (>= 3.7, < 5.0) - jekyll-commonmark-ghpages (0.1.5) - commonmarker (~> 0.17.6) - jekyll-commonmark (~> 1) - rouge (~> 2) - jekyll-default-layout (0.1.4) - jekyll (~> 3.0) - jekyll-feed (0.11.0) - jekyll (~> 3.3) jekyll-gist (1.5.0) octokit (~> 4.2) - jekyll-github-metadata (2.12.1) - jekyll (~> 3.4) - octokit (~> 4.0, != 4.4.0) - jekyll-mentions (1.4.1) + jekyll-github-metadata (2.16.1) + jekyll (>= 3.4, < 5.0) + octokit (>= 4, < 7, != 4.4.0) + jekyll-include-cache (0.2.1) + jekyll (>= 3.7, < 5.0) + jekyll-mentions (1.6.0) html-pipeline (~> 2.3) - jekyll (~> 3.0) - jekyll-optional-front-matter (0.3.0) - jekyll (~> 3.0) + jekyll (>= 3.7, < 5.0) + jekyll-optional-front-matter (0.3.2) + jekyll (>= 3.0, < 5.0) jekyll-paginate (1.1.0) - jekyll-readme-index (0.2.0) - jekyll (~> 3.0) - jekyll-redirect-from (0.14.0) - jekyll (~> 3.3) - jekyll-relative-links (0.6.0) - jekyll (~> 3.3) - jekyll-remote-theme (0.3.1) - jekyll (~> 3.5) - rubyzip (>= 1.2.1, < 3.0) + jekyll-readme-index (0.3.0) + jekyll (>= 3.0, < 5.0) + jekyll-redirect-from (0.16.0) + jekyll (>= 3.3, < 5.0) + jekyll-relative-links (0.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-remote-theme (0.4.3) + addressable (~> 2.0) + jekyll (>= 3.5, < 5.0) + jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) + rubyzip (>= 1.3.0, < 3.0) jekyll-sass-converter (1.5.2) sass (~> 3.4) - jekyll-seo-tag (2.5.0) - jekyll (~> 3.3) - jekyll-sitemap (1.2.0) - jekyll (~> 3.3) - jekyll-swiss (0.4.0) - jekyll-theme-architect (0.1.1) - jekyll (~> 3.5) + jekyll-seo-tag (2.8.0) + jekyll (>= 3.8, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-swiss (1.0.0) + jekyll-theme-architect (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.1.1) - jekyll (~> 3.5) + jekyll-theme-cayman (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.1.1) - jekyll (~> 3.5) + jekyll-theme-dinky (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.1.1) - jekyll (~> 3.5) + jekyll-theme-hacker (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.1.1) - jekyll (~> 3.5) + jekyll-theme-leap-day (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.1.1) - jekyll (~> 3.5) + jekyll-theme-merlot (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.1.1) - jekyll (~> 3.5) + jekyll-theme-midnight (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.1.1) - jekyll (~> 3.5) + jekyll-theme-minimal (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.1.1) - jekyll (~> 3.5) + jekyll-theme-modernist (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.5.3) - jekyll (~> 3.5) + jekyll-theme-primer (0.6.0) + jekyll (> 3.5, < 5.0) jekyll-github-metadata (~> 2.9) jekyll-seo-tag (~> 2.0) - jekyll-theme-slate (0.1.1) - jekyll (~> 3.5) + jekyll-theme-slate (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.1.1) - jekyll (~> 3.5) + jekyll-theme-tactile (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.1.1) - jekyll (~> 3.5) + jekyll-theme-time-machine (0.2.0) + jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-titles-from-headings (0.5.1) - jekyll (~> 3.3) + jekyll-titles-from-headings (0.5.3) + jekyll (>= 3.3, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - jemoji (0.10.2) - gemoji (~> 3.0) + jemoji (0.13.0) + gemoji (>= 3, < 5) html-pipeline (~> 2.2) - jekyll (~> 3.0) - kramdown (1.17.0) - liquid (4.0.0) - listen (3.1.5) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) - ruby_dep (~> 1.2) + jekyll (>= 3.0, < 5.0) + json (2.7.2) + kramdown (2.4.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.4) + listen (3.9.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + logger (1.6.1) mercenary (0.3.6) - mini_portile2 (2.4.0) - minima (2.5.0) - jekyll (~> 3.5) + mini_portile2 (2.8.7) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) - minitest (5.11.3) - multipart-post (2.1.1) - nokogiri (1.10.3) - mini_portile2 (~> 2.4.0) - octokit (4.14.0) - sawyer (~> 0.8.0, >= 0.5.3) + minitest (5.25.1) + net-http (0.4.1) + uri + nokogiri (1.16.7) + mini_portile2 (~> 2.8.2) + racc (~> 1.4) + octokit (4.25.1) + faraday (>= 1, < 3) + sawyer (~> 0.9) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (3.0.3) - rb-fsevent (0.10.3) - rb-inotify (0.10.0) + public_suffix (5.1.1) + racc (1.8.1) + rb-fsevent (0.11.2) + rb-inotify (0.11.1) ffi (~> 1.0) - rouge (2.2.1) - ruby-enum (0.7.2) - i18n - ruby_dep (1.5.0) - rubyzip (1.2.3) + rexml (3.3.8) + rouge (3.30.0) + rubyzip (2.3.2) safe_yaml (1.0.5) sass (3.7.4) sass-listen (~> 4.0.0) sass-listen (4.0.0) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) - sawyer (0.8.2) + sawyer (0.9.2) addressable (>= 2.3.5) - faraday (> 0.8, < 2.0) + faraday (>= 0.17.3, < 3) + securerandom (0.3.1) + simpleidn (0.2.3) terminal-table (1.8.0) unicode-display_width (~> 1.1, >= 1.1.1) - thread_safe (0.3.6) - typhoeus (1.3.1) + typhoeus (1.4.1) ethon (>= 0.9.0) - tzinfo (1.2.5) - thread_safe (~> 0.1) - unicode-display_width (1.6.0) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) + unicode-display_width (1.8.0) + uri (0.13.1) + webrick (1.8.2) PLATFORMS ruby + x64-mingw32 + x86-mingw32 DEPENDENCIES github-pages BUNDLED WITH - 2.0.1 + 2.5.21 diff --git a/README.md b/README.md new file mode 100644 index 000000000..bd38f6e2a --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Mozzletoff WOW Goldfarm site + +This page is used by [Mozzletoff](https://www.twitch.tv/mozzletoff) to display various gold making process, shuffles and TSM3/4 Groups & Operations Data. + +You can visit the more formal website displayed on GitHub Pages via Jekyll [here](https://gunnydelight.github.io/mozzletoff-wow-goldfarm-site/) + +## Social Medias + +[Twitch TV](https://www.twitch.tv/mozzletoff) + +[YouTube Guides](https://www.youtube.com/c/MozzletoffWoW) + +[Twitter](https://twitter.com/mozzletoffWOW) + +[Instagram](https://www.instagram.com/mozzletoffwow/) + +[Mozzle's Discord](http://discord.me/mozzletoff) + +## Support the Content + +[Patreon](https://www.patreon.com/mozzletoffwow) + +[Twitch donation](https://streamlabs.com/mozzletoff/tip) + +[Crypto Dono](https://1upcoin.com/donate/mozzletoff) + +[PayPal Dono](https://streamlabs.com/mozzletoff/tip) + +[Ms Katelynn NICU support](https://www.gofundme.com/f/katelynn-joy-nicu-fund) diff --git a/_config.yml b/_config.yml index 20a683ec4..8c7f5105c 100644 --- a/_config.yml +++ b/_config.yml @@ -1,18 +1,18 @@ -repository: tomjoht/documentation-theme-jekyll +repository: Gunnydelight/mozzletoff-wow-goldfarm-site output: web # this property is useful for conditional filtering of content that is separate from the PDF. -topnav_title: Jekyll Documentation Theme +topnav_title: Mozzletoff's GH Website # this appears on the top navigation bar next to the home button -site_title: Jekyll theme for documentation +site_title: Mozzletoff Gold Farming Website # this appears in the html browser tab for the site title (seen mostly by search engines, not users) -company_name: Your company +company_name: Mozzletoff, Inc. # this appears in the footer -github_editme_path: tomjoht/documentation-theme-jekyll/blob/gh-pages/ +github_editme_path: Gunnydelight/mozzletoff-wow-goldfarm-site # 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. # gitlab_editme_path: tomjoht/documentation-theme-jekyll/blob/gh-pages/ @@ -21,7 +21,7 @@ github_editme_path: tomjoht/documentation-theme-jekyll/blob/gh-pages/ disqus_shortname: idratherbewriting # if you're using disqus for comments, add the shortname here. if not, leave this value blank. -google_analytics: UA-66296557-1 +google_analytics: # if you have google-analytics ID, put it in. if not, edit this value to blank. host: 127.0.0.1 @@ -36,9 +36,9 @@ exclude: - vendor # these are the files and directories that jekyll will exclude from the build -feedback_subject_line: Jekyll documentation theme +feedback_subject_line: feedback for Mozzletoff GH-Pages site -feedback_email: tomjoht@gmail.com +feedback_email: mozzletoffgaming@gmail.com # used as a contact email for the Feedback link in the top navigation bar # feedback_disable: true diff --git a/_data/sidebars/home_sidebar.yml b/_data/sidebars/home_sidebar.yml index fbf43d51f..bc3843415 100644 --- a/_data/sidebars/home_sidebar.yml +++ b/_data/sidebars/home_sidebar.yml @@ -1,22 +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: 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 + - 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 \ No newline at end of file diff --git a/_data/sidebars/mydoc_sidebar.yml b/_data/sidebars/mydoc_sidebar.yml index fe506cd4c..5f0e8abf7 100644 --- a/_data/sidebars/mydoc_sidebar.yml +++ b/_data/sidebars/mydoc_sidebar.yml @@ -2,8 +2,8 @@ entries: - title: sidebar - product: Jekyll Doc Theme - version: 6.0 + product: Gold Making Guides + version: 1.0 folders: - title: @@ -19,277 +19,405 @@ entries: output: pdf type: frontmatter - - title: Overview + - title: Website & Author Introduction output: web, pdf folderitems: - - title: Get started - url: /index.html - output: web, pdf - type: homepage + - title: Introduction to the website + url: /mydoc_introduction.html + output: web, pdf + type: - - title: Introduction - url: /mydoc_introduction.html - output: web, pdf + - title: About the Website creator + url: /mydoc_about.html + output: web, pdf + type: + + - title: Content Creators page + url: /mydoc_contentcreators.html + output: web, pdf + type: + - + - title: Home Page + url: /index.html + output: web, pdf + type: - - title: Supported features - url: /mydoc_supported_features.html - output: web, pdf - - title: About the theme author - url: /mydoc_about.html + - title: Vanilla Shuffles + output: web, pdf + folderitems: + + - title: Vanilla - Arcanite Bar shuffle + url: /vanilla-arcanite-bar-shuffle.html output: web, pdf + type: - - title: Support - url: /mydoc_support.html + - title: Classic - Thick Leather vendor shuffle + url: /classic-thick-leather-vendor-shuffle.html output: web, pdf + type: + + subfolders: + - title: Vanilla - Profession Shuffle Pages + output: web + subfolderitems: - - title: Release Notes + - title: Content Soon! + url: + output: web + + - title: BC Shuffles output: web, pdf folderitems: - - title: 6.0 Release notes - url: /mydoc_release_notes_60.html + - title: Primal Might shuffle + url: /bc-primal-might-shuffle.html output: web, pdf - - title: 5.0 Release notes - url: /mydoc_release_notes_50.html - output: web, pdf + subfolders: + - title: BC - Profession Shuffle Page + output: web + subfolderitems: - - title: Installation + - title: Content Soon! + url: + output: web + + - title: WOTLK Shuffles output: web, pdf folderitems: - - title: About Ruby, Gems, Bundler, etc. - url: /mydoc_about_ruby_gems_etc.html + - title: Mekgineer's Chopper shuffle + url: /wotlk-mekingeers-chopper-shuffle.html output: web, pdf - - title: Install Jekyll on Mac - url: /mydoc_install_jekyll_on_mac.html - output: web, pdf + subfolders: + - title: WOTLK - Profession Shuffle Page + output: web + subfolderitems: - - title: Install Jekyll on Windows - url: /mydoc_install_jekyll_on_windows.html - output: web, pdf + - title: Content Soon! + url: + output: web - - title: Authoring + - title: Cataclysm Shuffles + output: web, pdf + folderitems: + + - title: Truegold shuffle + url: /cata-truegold-shuffle.html + output: web, pdf + + - title: Vial of the Sands shuffle + url: /cata-vial-of-the-sands-shuffle.html + output: web, pdf + + - title: Titanium Bar and Titan Steel shuffle + url: /cata-titanium-bar-titansteel-shuffle.html + output: web, pdf + + subfolders: + - title: Cata - Profession Shuffle Page + output: web + subfolderitems: + + - title: Content Soon! + url: + output: web + + - title: MOP Shuffles output: web, pdf folderitems: - - title: Pages - url: /mydoc_pages.html + - title: Living Steel shuffle + url: /mop-living-steel-shuffle.html output: web, pdf - - title: Posts - url: /mydoc_posts.html + - title: Sky Golem shuffle + url: /mop-sky-golem-shuffle.html output: web, pdf - - title: Lists - url: /mydoc_lists.html + - title: Depleted Kyparium Rocket shuffle + url: /mop-depleted-kyparium-rocket-shuffle.html output: web, pdf - - title: Conditional logic - url: /mydoc_conditional_logic.html + - title: Geosynchronous World Spinner shuffle + url: /mop-geosynchronous-world-spinner.html output: web, pdf - - title: Content reuse - url: /mydoc_content_reuse.html + - title: Panther Mounts shuffle + url: /mop-panther-mount-shuffle.html output: web, pdf - - title: Collections - url: /mydoc_collections.html + - title: Ghost Iron, Kyparite and Trillium Ore shuffle + url: /mop-ore-shuffle.html output: web, pdf - - title: WebStorm editor tips - url: /mydoc_webstorm_text_editor.html + - title: Trillium Bar shuffle + url: /mop-trillium-bar-shuffle.html output: web, pdf - - title: Atom editor tips - url: /mydoc_atom_text_editor.html + - title: MOP Gems shuffle + url: /mop-gem-shuffle.html output: web, pdf - - title: Navigation + subfolders: + - title: MOP - Profession Shuffle Page + output: web + subfolderitems: + + - title: Content Soon! + url: + output: web + + - title: WOD Shuffles output: web, pdf folderitems: - - title: Sidebar navigation - url: /mydoc_sidebar_navigation.html + - title: Sorcerous Earth shuffle + url: /wod-sorcerous-earth-shuffle.html output: web, pdf - - title: YAML tutorial in the context of Jekyll - url: /mydoc_yaml_tutorial.html + - title: Card of Omens shuffle + url: /wod-card-of-omens-shuffle.html output: web, pdf - - title: Tags - url: /mydoc_tags.html + - title: Alchemy Trinket vendor shuffle + url: /wod-alchemy-trinket-vendor-shuffle.html output: web, pdf - - title: Series - url: /mydoc_series.html - output: web, pdf + subfolders: + - title: WOD - Profession Shuffle Page + output: web + subfolderitems: + + - title: Content Soon! + url: + output: web - - title: Formatting + - title: Legion Shuffles output: web, pdf folderitems: - - title: Tooltips - url: /mydoc_adding_tooltips.html + - title: Blood of Sargeras shuffle + url: /legion-blood-of-sargeras-shuffle.html output: web, pdf - - title: Alerts - url: /mydoc_alerts.html - output: web, pdf + subfolders: + - title: Legion - Profession Shuffle Page + output: web + subfolderitems: - - title: Icons - url: /mydoc_icons.html - output: web, pdf + - title: Content Soon! + url: + output: web - - title: Images - url: /mydoc_images.html - output: web, pdf + - title: BFA Shuffles + output: web, pdf - - title: Code samples - url: /mydoc_code_samples.html + folderitems: + - title: Anchor Weed shuffle + url: /bfa-anchor-weed-shuffle.html output: web, pdf - - title: Labels - url: /mydoc_labels.html + - title: Bountiful Feasts shuffle + url: /bfa-bountiful-feasts-shuffle.html output: web, pdf - - title: Links - url: /mydoc_hyperlinks.html + - title: Inscription Milling shuffle + url: /bfa-inscription-milling-shuffle.html output: web, pdf - - title: Navtabs - url: /mydoc_navtabs.html + - title: Monelite Ore Prospecting shuffle + url: /bfa-monelite-ore-prospecting-shuffle.html output: web, pdf - - title: Tables - url: /mydoc_tables.html + - title: Samadan's Super Bracer Shuffle + url: /bfa-bracer-shuffle.html output: web, pdf - - title: Syntax highlighting - url: /mydoc_syntax_highlighting.html + - title: Veiled Crystals via Inscription + url: /bfa-inscription-veiled-shuffle.html output: web, pdf - - title: Workflow maps - url: /mydoc_workflow_maps.html - output: web, pdf + # - title: Git collaboration +# url: /mydoc_git_collaboration +# output: web, pdf + + subfolders: + - title: BFA - Profession Shuffle Page + output: web + subfolderitems: - - title: Handling reviews + - title: Content Soon! + url: + output: web, pdf + + - title: Shadowlands Shuffles output: web, pdf folderitems: - - title: Commenting on files - url: /mydoc_commenting_on_files.html - output: web, pdf + - title: Soon! Relics of the Past... JK >:) + url: + output: web, pdf -# - title: Git collaboration -# url: /mydoc_git_collaboration -# output: web, pdf + subfolders: + - title: SL - Profession Shuffle page + output: web + subfolderitems: - - title: Publishing - output: web, pdf + - title: Content Soon! + url: + output: web + - title: Shadowlands MB/Goup farms + output: web folderitems: - - title: Build arguments - url: /mydoc_build_arguments.html - output: web, pdf - - title: Themes - url: /mydoc_themes.html - output: web, pdf + - title: SOON! Introduction Overview + url: + output: web - - title: Generating PDFs - url: /mydoc_generating_pdfs.html - output: web, pdf + - title: World MB/Group farms + output: web + folderitems: - - title: Help APIs and UI tooltips - url: /mydoc_help_api.html - output: web, pdf + - title: SOON! Introduction Overview + url: + output: web - - title: Search configuration - url: /mydoc_search_configuration.html - output: web, pdf + - title: SOON! Nazmir - Alliance Tul'vor + url: + output: web - - title: iTerm profiles - url: /mydoc_iterm_profiles.html - output: web, pdf + - title: SOON! Vol'Dun - Crater of Conq + url: + output: web - - title: Pushing builds to server - url: /mydoc_push_build_to_server.html - output: web, pdf + - title: SOON! Stormsong Valley - Mariner's Strand + url: + output: web - - title: Publishing on Github Pages - url: /mydoc_publishing_github_pages.html - output: web, pdf + - title: SOON! Stormsong Valley - Boat + url: + output: web - - title: Special layouts - output: web, pdf + - title: SOON! Drustvar - Boars Farm + url: + output: web - folderitems: - - title: Knowledge-base layout - url: /mydoc_kb_layout.html - output: web, pdf + - title: SOON! Nazjatar Farm + url: + output: web - - title: Glossary layout - url: /mydoc_glossary.html - output: web, pdf + - title: SOON! Primals Farm + url: + output: web - - title: FAQ layout - url: /mydoc_faq_layout.html - output: web, pdf + - title: SOON! Volatiles Farm + url: + output: web - - title: Shuffle layout - url: /mydoc_shuffle.html - output: web, pdf + - title: SOON! Eternals Farm + url: + output: web - - title: Troubleshooting - output: web, pdf + - title: SOON! Sumptuous Fur Farm + url: + output: web + - title: World Pet farms + output: web folderitems: - - title: Troubleshooting - url: /mydoc_troubleshooting.html - output: web, pdf + - title: SOON! Intro for Pet Solo/Group farms + url: + output: web + + - title: SOON! Emerald Whelpling + url: + output: web + + - title: SOON! Bronze Whelpling + url: + output: web + + - title: SOON! Crimson Whelpling + url: + output: web - - title: Tag archives + - title: SOON! Dark Whelpling + url: + output: web + + - title: SOON! Azure Whelpling + url: + output: web + + - title: SOON! Filthling + url: + output: web + + - title: World Mount farms output: web folderitems: - - title: Tag archives overview - url: /mydoc_tag_archives_overview.html - output: web + - title: SOON! Introduction Overview + url: + output: web - subfolders: - - title: Tag archive pages + - title: SOON! BFA World Mounts + url: output: web - subfolderitems: + - title: Herb | Mining Farming Routes + output: web, pdf - - title: Formatting pages - url: /tag_formatting.html - output: web + folderitems: + - title: SOON! Introduction Overview + url: + output: web - - title: Navigation pages - url: /tag_navigation.html - output: web + - title: SOON! Herbing & Mining Routes Overview + url: + output: web, pdf - - title: Content types pages - url: /tag_content_types.html - output: web + - title: TSM 4 Groups and OP's + output: web, pdf - - title: Publishing pages - url: /tag_publishing.html - output: web + folderitems: + - title: TSM Introduction Overview + url: /introduction-to-mozzles-tsm.html + output: web, pdf - - title: Special layout pages - url: /tag_special_layouts.html - output: web + - title: Mozzle's TSM4 Groups & Op's + url: /tsm-four-groups-and-operations.html + output: web, pdf - - title: Collaboration pages - url: /tag_collaboration.html - output: web + - title: SOON! 4.10 TSM4 Goups & Op's + url: /tsm-four-groups-and-operations.html + output: web, pdf - - title: Troubleshooting pages - url: /tag_troubleshooting.html - output: web + - title: SOON! Shadowlands Groups & Op's + url: /tsm-four-groups-and-operations.html + output: web, pdf + + - title: Goldmaking Tips & Tricks + output: web, pdf + folderitems: + + - title: Profession Cooldown Macro Groups + url: /profession-cooldown-macro-groups.html + output: web, pdf + + - title: Login Daily for Goldmaking SOON!! + url: + output: web + + - title: War Within Alt Conc Army SOON!! + url: + output: web + + - title: SOON! Helpful URLs SOON!! + url: + output: web \ No newline at end of file diff --git a/_data/topnav.yml b/_data/topnav.yml index 1e4036150..0e677b29e 100644 --- a/_data/topnav.yml +++ b/_data/topnav.yml @@ -4,29 +4,129 @@ topnav: - title: Topnav items: - title: GitHub - external_url: https://github.com/tomjoht/documentation-theme-jekyll - - title: News - url: /news + external_url: https://github.com/Gunnydelight/mozzletoff-wow-goldfarm-site + - title: About Me + url: /mydoc_about.html + #Topnav dropdowns topnav_dropdowns: - title: Topnav dropdowns folders: - - title: Jekyll Help + - title: Mozzle's Social Medias + folderitems: + - title: Twitch TV + external_url: https://www.twitch.tv/mozzletoff + - title: YouTube Guides + external_url: https://www.youtube.com/c/MozzletoffWoW + - title: Twitter + external_url: https://twitter.com/mozzletoffWOW + - title: Instagram + external_url: https://www.instagram.com/mozzletoffwow/ + - title: Discord + external_url: http://discord.me/mozzletoff + - title: Support folderitems: - - 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 + - title: Patreon + external_url: https://www.patreon.com/mozzletoffwow + - title: Twitch donation + external_url: https://streamlabs.com/mozzletoff/tip + - title: Crypto Dono + external_url: https://1upcoin.com/donate/mozzletoff + - title: PayPal Dono + external_url: https://streamlabs.com/mozzletoff/tip + - title: Ms Katelynn NICU support + external_url: https://www.gofundme.com/f/katelynn-joy-nicu-fund + - title: TTV Creators + folderitems: + - title: Mozzletoff (MB) + external_url: https://www.twitch.tv/Mozzletoff + - title: Arnota42 (MB) + external_url: https://www.twitch.tv/arnota42 + - title: iBabyPowder (MB) + external_url: https://www.twitch.tv/ibabypowder + - title: Canadia_TV (MB) + external_url: https://www.twitch.tv/canadia_tv + - title: FarmerTru (MB) + external_url: https://www.twitch.tv/farmertru + - title: Kittymowwmow (MB) + external_url: https://www.twitch.tv/kittymowwmow + - title: Movie1011 (MB) + external_url: https://www.twitch.tv/movie1011 + - title: Persephonae (MB) + external_url: https://www.twitch.tv/persephonae + - title: Simply Suzu (MB) + external_url: https://www.twitch.tv/simplysuzu + - title: Rafipi (MB) + external_url: https://www.twitch.tv/Rafipi + - title: Ridosaw (MB) + external_url: https://www.twitch.tv/Ridosaw + - title: SkitzYoTV (MB) + external_url: https://www.twitch.tv/skitzyotv + - title: Smesus + external_url: https://www.twitch.tv/smesus + - title: Speity (MB) + external_url: https://www.twitch.tv/speity + - title: WTBGold (MB) + external_url: https://twitch.tv/alfredgg + - title: SamadanPlaysWOW + external_url: https://www.twitch.tv/SamadanPlaysWOW + - title: BaconBits + external_url: https://www.twitch.tv/baconbits078 + - title: BregsVids + external_url: https://www.twitch.tv/BregVids + - title: DrizzlingRose + external_url: https://www.twitch.tv/drizzlingrose + - title: Derpalicious + external_url: https://www.twitch.tv/derpalicious + - title: Ellelaith + external_url: https://www.twitch.tv/ellelaith + - title: The Lazy Goldmaker + external_url: https://www.twitch.tv/lazygoldmaker + - title: ProfitzTV (LAC creator) + external_url: https://www.twitch.tv/profitztv + - title: Pulsatingsac + external_url: https://www.twitch.tv/pulsatingsac + - title: SeaThrift + external_url: https://www.twitch.tv/seathrift + - title: SenzasGames + external_url: https://www.twitch.tv/senzasgames + - title: StudenAlbatroz + external_url: https://www.twitch.tv/studenalbatroz + - title: Tr4xindus + external_url: https://www.twitch.tv/tr4xindus + - title: WOWTumaka + external_url: https://www.twitch.tv/wowtumaka + + - title: YT Creators 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 + - title: Mozzletoff + external_url: https://www.youtube.com/c/MozzletoffWoW + - title: BabyPowder + external_url: https://www.youtube.com/c/babypowdersguides + - title: BregVids + external_url: https://www.youtube.com/bregvids + - title: CanadianTV + external_url: https://www.youtube.com/channel/UCxgzYGsphDNNMQd0KfKGnHA + - title: Dala GG + external_url: https://www.youtube.com/channel/UCBWE80KzTUR-DIUDJMU-mFQ + - title: Hikons + external_url: https://www.youtube.com/channel/UCg-zFvILTJJGDyx2PDCSmKw + - title: KomLit + external_url: https://www.youtube.com/user/KomLit + - title: Kraken Latte + external_url: https://www.youtube.com/user/KibaVahnGoth + - title: LonMeasley + external_url: https://youtube.com/channel/UCjThCEnBRpZUfmG6zmJS12A + - title: Meraki's Method + external_url: https://www.youtube.com/channel/UCGDZxZz258ayHGXSmmaZ51Q + - title: SamadanPlaysWOW + external_url: https://www.youtube.com/channel/UC1jxWx5pF12P-BV-62x0HRQ + - title: Seathrift + external_url: https://www.youtube.com/seathrift + - title: StudenAlbatroz + external_url: https://www.youtube.com/channel/UCdstOzMVSXEjpBrNYyG_D0A + - title: Tr4xindus + external_url: https://www.youtube.com/c/tr4xgaming + - title: WTB Gold + external_url: https://www.youtube.com/channel/UCTUo98NJmvkyP4ltv5W3D9g diff --git a/_layouts/page.html b/_layouts/page.html index a1b4d6550..1d9695b39 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -59,7 +59,6 @@

{{ page.title }}

{% endif %} -{% include disqus.html %} diff --git a/_layouts/post.html b/_layouts/post.html index 0d09f2fa4..ebc72744a 100644 --- a/_layouts/post.html +++ b/_layouts/post.html @@ -32,8 +32,6 @@

{{ page.title }}

-{% include disqus.html %} - {{site.data.alerts.hr_shaded}} {% include footer.html %} diff --git a/images/androidsdkmanagericon.png b/images/androidsdkmanagericon.png deleted file mode 100644 index 65014a260..000000000 Binary files a/images/androidsdkmanagericon.png and /dev/null differ diff --git a/images/authorizegithubscreen2.png b/images/authorizegithubscreen2.png deleted file mode 100644 index 2f6b6ca0f..000000000 Binary files a/images/authorizegithubscreen2.png and /dev/null differ diff --git a/images/authorizeongithub.png b/images/authorizeongithub.png deleted file mode 100644 index 9380f80c3..000000000 Binary files a/images/authorizeongithub.png and /dev/null differ diff --git a/images/bfa-samadan-bracer-shuffle.png b/images/bfa-samadan-bracer-shuffle.png new file mode 100644 index 000000000..bdc811539 Binary files /dev/null and b/images/bfa-samadan-bracer-shuffle.png differ diff --git a/images/bfa-silas-potion-of-prosperity.png b/images/bfa-silas-potion-of-prosperity.png new file mode 100644 index 000000000..1de843a56 Binary files /dev/null and b/images/bfa-silas-potion-of-prosperity.png differ diff --git a/images/company_logo.png b/images/company_logo.png index f2d9e7ee0..bd322159b 100644 Binary files a/images/company_logo.png and b/images/company_logo.png differ diff --git a/images/company_logo_big.png b/images/company_logo_big.png deleted file mode 100644 index 2a4b9e8e0..000000000 Binary files a/images/company_logo_big.png and /dev/null differ diff --git a/images/favicon.ico b/images/favicon.ico deleted file mode 100644 index 0d505bed3..000000000 Binary files a/images/favicon.ico and /dev/null differ diff --git a/images/helpapi-01.png b/images/helpapi-01.png deleted file mode 100644 index 51308a163..000000000 Binary files a/images/helpapi-01.png and /dev/null differ diff --git a/images/helpapi.svg b/images/helpapi.svg deleted file mode 100644 index 0ddc9227e..000000000 --- a/images/helpapi.svg +++ /dev/null @@ -1,1661 +0,0 @@ - - - - - - - - - - - - - - - - - sample help text sample help text sample help text sample help text sample help text sample help text sample help - - - - - - - - - - - - - - - - - - - - - - - Getting Started text sample help text sample help text sample help text sample help text sample help text sample help text sample - - - - - - - - - - - - - Learning Coursesample help text sample help text sample help text sample help text sample help text sample help text sample help - - - - - - - - - - - - - - - - - - - sample help text sample help text sample help text sample help text sample help text sample - - - - - - - - - - - - - - - Help API - - - -pulling from API - - - -pulling from API - - - -pulling from API - - - -pulling from API - - - - - - - website #1 - - website #2 - - website #4 - - website #3 - - diff --git a/images/illustratoroptions.png b/images/illustratoroptions.png deleted file mode 100644 index d043971dd..000000000 Binary files a/images/illustratoroptions.png and /dev/null differ diff --git a/images/itermexample.png b/images/itermexample.png deleted file mode 100644 index e412af02a..000000000 Binary files a/images/itermexample.png and /dev/null differ diff --git a/images/jekyll.png b/images/jekyll.png deleted file mode 100644 index ebaf27d0e..000000000 Binary files a/images/jekyll.png and /dev/null differ diff --git a/images/killalljekyll.png b/images/killalljekyll.png deleted file mode 100644 index aa8adaa2a..000000000 Binary files a/images/killalljekyll.png and /dev/null differ diff --git a/images/liningup.png b/images/liningup.png deleted file mode 100644 index ede4dc07c..000000000 Binary files a/images/liningup.png and /dev/null differ diff --git a/images/workflowarrow.png b/images/workflowarrow.png deleted file mode 100644 index 91a3e8161..000000000 Binary files a/images/workflowarrow.png and /dev/null differ diff --git a/index.md b/index.md index 54320cc15..1459ccc38 100644 --- a/index.md +++ b/index.md @@ -1,410 +1,76 @@ --- -title: "Getting started with the Documentation Theme for Jekyll" +title: "Getting started with Goldfarming..." keywords: sample homepage tags: [getting_started] sidebar: mydoc_sidebar permalink: index.html -summary: These brief instructions will help you get started quickly with the theme. The other topics in this help provide additional information and detail about working with other aspects of this theme and Jekyll. +summary: These brief instructions will help you get started quickly with the Website. Where do you get started? How do you navigate? What type of Content? How can I give you feedback? The list of questions go on... I touch base on those below! --- -{% include note.html content="If you're cloning this theme, you're probably writing documentation of some kind. I have a blog on technical writing here called I'd Rather Be Writing. If you'd like to stay updated with the latest trends, best practices, and other methods for writing documentation, consider subscribing. I also have a site on writing API documentation." %} +{% include note.html content="Please support the website by following the [Social Medias](https://linktr.ee/mozzletoffwow) above! If this is content you're looking for & like to be built upon & continued for current content, consider [Supporting](https://streamlabs.com/mozzletoff/tip) the content - **ONLY** if in a position to." %} -## Build the Theme +## Overview -Follow these instructions to build the theme. +Welcome! This site is for World of Warcraft gold farmers to find gold farming related material in a single location in an easy to navigate using the top & side nav bars. -### 1. Download the theme +## What is different about your site than the other 100 out there? +I, like some of you, find myself going to 5+ multiple sites to gather information. +This website's purpose is to pool together content creators relevant & usable content to a single website. When dealing with content creators, they tend to put out content differently over time. Here the information will be presented the same consistent _(as Jekyll helps with that here through various commands)_ feel across the various Expansions. -First, download or clone the theme from the [Github repo](https://github.com/tomjoht/documentation-theme-jekyll). Most likely you won't be pulling in updates once you start customizing the theme, so downloading the theme (instead of cloning it) probably makes the most sense. In Github, click the **Clone or download** button, and then click **Download ZIP**. +What I’m looking to do is to “melting pot” WOW Goldfarming resources while crediting original Content creators sources together for Users to just find in a single spot. -### 2. Install Jekyll -If you've never installed or run a Jekyll site locally on your computer, follow these instructions to install Jekyll: +## Table of Contents - How the Shuffles will be displayed -* [Install Jekyll on Mac][mydoc_install_jekyll_on_mac] -* [Install Jekyll on Windows][mydoc_install_jekyll_on_windows] +This website will highlight various relevant shuffles through each expansion. You can see the Example layout [here](https://gunnydelight.github.io/mozzletoff-wow-goldfarm-site/example.html). -### 3. Install Bundler +It highlights the following: -In case you haven't installed Bundler, install it: +- Overview (Visualization Guide) +- Google Sheet calculator +- What can you earn +- Items involved in the shuffle +- Prerequisites to Shuffle +- Steps by Steps exlanation +- Tips and Tricks +- Reference Links -``` -gem install bundler -``` -You'll want [Bundler](http://bundler.io/) to make sure all the Ruby gems needed work well with your project. Bundler sorts out dependencies and installs missing gems or matches up gems with the right versions based on gem dependencies. +# Getting started -### 4. Option 1: Build the Theme (*without* the github-pages gem) {#option1} +## Where do I begin? +To get started, see our [Goldfarm Guides section](https://gunnydelight.github.io/mozzletoff-wow-goldfarm-site/index.html). -Use this option if you're not planning to publish your Jekyll site using [Github Pages](https://pages.github.com/). +## What type of Gold farm content? +I personally am a casual gold farmer. I try to make the most amount of gold with the limited time available to play. I have over 90+ level 110-120 alts leveraging daily CDs/professions and TSM Sniping/flipping. Type of gold farming content you can expect to find here: -Bundler's Gemfile specifies how project dependencies are managed. Although this project includes a Gemfile, this theme doesn't have any dependencies beyond core Jekyll. The Gemfile is used to list gems needed for publishing on Github Pages. **If you're not planning to have Github Pages build your Jekyll project, delete these two files from the theme's root directory:** +* maximizing **Daily rotations** for steady gold income +* Shuffles from **Vanilla** to **Current content** inside WOW +* Multiple _Herbing_ routes for each Herb +* Multiple _Mining_ routes for each Ore +* 5 man Group & x5 Multibox farms +* **TSM 3** groups & Operations +* **TSM 4** groups & Operations +* Showcase other current/active WOW Gold Farm Content Creators -* Gemfile -* Gemfile.lock +## Top Navigation Bar +You will see a top navigation bar at the top. This is where I host external relevant content which includes the following: -If you've never run Jekyll on your computer (you can check with `jekyll --version`), you may need to install the jekyll gem: +- disabling Nav side bar (website real estate is a must IMO) +- GitHub repo for the raw files +- About Me! +- My Social Medias for Gold Farm content +- Support the content (if you cant financially support, follow is support!) +- Twitch TV Content Creators that are Active (Gold Farm content, actively streaming) +- YouTube Content creators that are Active (not click bait, library/source of reliable & relevant Gold Farm guides, walkthroughs, explanations. +- Feedback - way to get in touch with me! -``` -gem install jekyll -``` +## Side Navigation Bar +Here is where you will go to the collapsible and expandable navigation bar to find the relevant content you want. You can click on each Expansion release to see the various shuffles under that expansion. -Now run jekyll serve (first change directories (`cd`) to where you downloaded the project): +> Note: If you see any missing shuffles, please get in contact with my ont he social media along the top to add or click feedback to send me an email. Both will work for me! -``` -jekyll serve -``` +## Feedback +Scroll to the top navigation bar and select feedback. It’ll open your local machine’s default Mailbox option to send me your feedback. -### 4. Option 2: Build the Theme (*with* the github-pages gem) {#option2} - -If you *are* in fact publishing on Github Pages, leave the Gemfile and Gemfile.lock files in the theme.The Gemfile tells Jekyll to use the github-pages gem. **However, note that you cannot use the normal `jekyll serve` command with this gem due to dependency conflicts between the latest version of Jekyll and Github Pages** (which are noted [briefly here](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/)). - -You need Bundler to resolve these dependency conflicts. Use Bundler to install all the needed Ruby gems: - -``` -bundle update -``` - -Then *always* use this command to build Jekyll: - -``` -bundle exec jekyll serve -``` - -If you want to shorten this long command, you can put this code in a file such as jekyll.sh (on a Mac) and then simply type `. jekyll.sh` to build Jekyll. - -## Running the site in Docker - -You can also use Docker to directly build and run the site on your local machine. Just clone the repo and run the following from your working dir: -``` -docker-compose build --no-cache && docker-compose up -``` -The site should now be running at [http://localhost:4000/](http://localhost:4000/). - -This is perhaps the easiest way to see how your site would actually look. - -## Configure the sidebar - -There are several products in this theme. Each product uses a different sidebar. This is the essence of what makes this theme unique -- different sidebars for different product documentation. The idea is that when users are reading documentation for a specific product, the sidebar navigation should be specific to that product. (You can read more of my thoughts on why multiple sidebars are important in this [blog post](http://idratherbewriting.com/2016/03/23/release-of-documentation-theme-for-jekyll-50/).) - -The top navigation usually remains the same, because it allows users to navigate across products. But the sidebar navigation adapts to the product. - -In each page's frontmatter, you must specify the sidebar you want that page to use. Here's an example of the page frontmatter showing the sidebar property: - -
----
-title: Alerts
-tags: [formatting]
-keywords: notes, tips, cautions, warnings, admonitions
-last_updated: July 3, 2016
-summary: "You can insert notes, tips, warnings, and important alerts in your content. These notes are stored as shortcodes made available through the linksrefs.hmtl include."
-sidebar: mydoc_sidebar
-permalink: mydoc_alerts
----
-
- -The `sidebar: mydoc_sidebar` refers to the \_data/sidebars/mydoc_sidebar.yml file. - -Note that your sidebar can only have 2 levels (expand the **Tag archives** option to see an example of the second level). Given that each product has its own sidebar, this depth should be sufficient (it's really like 3 levels). Deeper nesting goes against usability recommendations. - -You can optionally turn off the sidebar on any page (e.g. landing pages). To turn off the sidebar for a page, you should set the page frontmatter tag as `hide_sidebar: true`. - -If you don't declare a sidebar, the `home_sidebar` file gets used as the default because this is the default specified in the config file: - -```yaml -- - scope: - path: "" - type: "pages" - values: - layout: "page" - comments: true - search: true - sidebar: home_sidebar - topnav: topnav -``` - -If you want to set different sidebar defaults based on different folders for your pages, specify your defaults like this: - -``` -- - scope: - path: "pages/mydoc" - type: "pages" - values: - layout: "page" - comments: true - search: true - sidebar: mydoc_sidebar - topnav: topnav -``` - -This would load the `mydoc_sidebar` for each file in **pages/mydoc**. You could set different defaults for different path scopes. - -For more detail on the sidebar, see [Sidebar navigation][mydoc_sidebar_navigation]. - -## Top navigation - -The top navigation works just like the sidebar. You can specify which topnav data file should load by adding a `topnav` property in your page, like this: - -```yaml -topnav: topnav -``` - -Here the topnav refers to the `_data/topnav.yml` file. - -Because most topnav options will be the same, the `_config.yml` file specifies the topnav file as a default: - -```yaml -- - scope: - path: "" - type: "pages" - values: - layout: "page" - comments: true - search: true - sidebar: home_sidebar - topnav: topnav -``` - -## Sidebar syntax - -The sidebar data file uses a specific YAML syntax that you must follow. Follow the sample pattern shown in the theme, specically looking at `mydoc_sidebar.yml` as an example: Here's a code sample showing all levels: - -```yaml -entries: -- title: sidebar - product: Jekyll Doc Theme - version: 6.0 - folders: - - 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: 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: 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 -``` - -Each `folder` or `subfolder` must contain a `title` and `output` property. Each `folderitem` or `subfolderitem` must contain a `title`, `url`, and `output` property. - -The two outputs available are `web` and `pdf`. (Even if you aren't publishing PDF, you still need to specify `output: web`). - -The YAML syntax depends on exact spacing, so make sure you follow the pattern shown in the sample sidebars. See my [YAML tutorial](mydoc_yaml_tutorial) for more details about how YAML works. - -{% include note.html content="If you have just one character of spacing off, Jekyll won't build due to the YAML syntax error. You'll see an error message in your console that says \"Error ... did not find expected key while parsing a block mapping at line 22 column 5. Error: Run jekyll build --trace for more information.\" If you encounter this, it usually refers to incorrect indentation or spacing in the YAML file. See the example mydoc_sidebar.yml file to see where your formatting went wrong." %} - -Each level must have at least one topic before the next level starts. You can't have a second level that contains multiple third levels without having at least one standalone topic in the second level. If you need a hierarchy that has a folder that contains other folders and no loose topics, use a blank `-` item like this: - -```yaml -entries: -- title: sidebar - product: Jekyll Doc Theme - version: 6.0 - folders: - - title: Overview - output: web, pdf - folderitems: - - - - - - 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 -``` - -To accommodate the title page and table of contents in PDF outputs, each product sidebar must list these pages before any other: - -```yaml -- title: - output: pdf - type: frontmatter - folderitems: - - title: - url: /titlepage - output: pdf - type: frontmatter - - title: - url: /tocpage - output: pdf - type: frontmatter -``` - -Leave the output as `output: pdf` for these frontmatter pages so that they don't appear in the web output. - -For more detail on the sidebar, see [Sidebar navigation][mydoc_sidebar_navigation] and [YAML tutorial][mydoc_yaml_tutorial]. - -## Relative links and offline viewing - -This theme uses relative links throughout so that you can view the site offline and not worry about which server or directory you're hosting it. It's common with tech docs to push content to an internal server for review prior to pushing the content to an external server for publication. Because of the need for seamless transferrence from one host to another, the site has to use relative links. - -To view pages locally on your machine (without the Jekyll preview server), they need to have the `.html` extension. The `permalink` property in the page's frontmatter (without surrounding slashes) is what pushes the files into the root directory when the site builds. - -## Page frontmatter - -When you write pages, include these same frontmatter properties with each page: - -```yaml ---- -title: "Some title" -tags: [sample1, sample2] -keywords: keyword1, keyword2, keyword3 -last_updated: Month day, year -summary: "optional summary here" -sidebar: sidebarname -permalink: filename.html ---- -``` - -(You will customize the values for each of these properties, of course.) - -For titles, surrounding the title in quotes is optional, but if you have a colon in the title, you must surround the title with quotation marks. If you have a quotation mark inside the title, escape it first with a backlash `\`. - -Values for `keywords` get populated into the metadata of the page for SEO. - -Values for `tags` must be defined in your \_data/tags.yml list. You also need a corresponding tag file inside the tags folder that follows the same pattern as the other tag files shown in the tags folder. (Jekyll won't auto-create these tag files.) - -If you don't want the mini-TOC to show on a page (such as for the homepage or landing pages), add `toc: false` in the frontmatter. - -The `permalink` value should be the same as your filename and include the ".html" file extension. - -For more detail, see [Pages][mydoc_pages]. - -## Where to store your documentation topics - -You can store your files for each product inside subfolders following the pattern shown in the theme. For example, product1, product2, etc, can be stored in their own subfolders inside the \_pages directory. Inside \_pages, you can store your topics inside sub-subfolders or sub-sub-folders to your heart's content. When Jekyll builds your site, it will pull the topics into the root directory and use the permalink for the URL. - -Note that product1, product2, and mydoc are all just sample content to demonstrate how to add multiple products into the theme. You can freely delete that content. - -For more information, see [Pages][mydoc_pages] and [Posts][mydoc_posts]. - -## Configure the top navigation - -The top navigation bar's menu items are set through the \_data/topnav.yml file. Use the top navigation bar to provide links for navigating from one product to another, or to navigate to external resources. - -For external URLs, use `external_url` in the item property, as shown in the example topnav.yml file. For internal links, use `url` the same was you do in the sidebar data files. - -Note that the topnav has two sections: `topnav` and `topnav_dropdowns`. The topnav section contains single links, while the `topnav_dropdowns` section contains dropdown menus. The two sections are independent of each other. - -## Generating PDF - -If you want to generate PDF, you'll need a license for [Prince XML](http://www.princexml.com/). You will also need to [install Prince](http://www.princexml.com/doc/installing/). You can generate PDFs by product (but not for every product on the site combined together into one massive PDF). Prince will work even without a license, but it will imprint a small Prince image on the first page, and you're supposed to buy the license to use it. - -If you're on Windows, install [Git Bash client](https://git-for-windows.github.io/) rather than using the default Windows command prompt. - -Open up the css/printstyles.css file and customize the email address (`youremail@domain.com`) that is listed there. This email address appears in the bottom left footer of the PDF output. You'll also need to create a PDF configuration file following the examples shown in the pdfconfigs folder, and also customize some build scripts following the same pattern shown in the root: pdf-product1.sh - -See the section on [Generating PDFs][mydoc_generating_pdfs] for more details about setting the theme up for this output. - -## Blogs / News - -For blog posts, create your markdown files in the \_posts folder following the sample formats. Post file names always begin with the date (YYYY-MM-DD-title). - -The news/news.html file displays the posts, and the news_archive.html file shows a yearly history of posts. In documentation, you might use the news to highlight product features outside of your documentation, or to provide release notes and other updates. - -See [Posts][mydoc_posts] for more information. - -## Markdown - -This theme uses [kramdown markdown](http://kramdown.gettalong.org/). kramdown is similar to Github-flavored Markdown, except that when you have text that intercepts list items, the spacing of the intercepting text must align with the spacing of the first character after the space of a numbered list item. Basically, with your list item numbering, use two spaces after the dot in the number, like this: - -``` -1. First item -2. Second item -3. Third item -``` - -When you want to insert paragraphs, notes, code snippets, or other matter in between the list items, use four spaces to indent. The four spaces will line up with the first letter of the list item (the First or Second or Third). - -``` -1. First item - - ``` - alert("hello"); - ``` - -2. Second item - - Some pig! - -3. Third item -``` - -See the topics under "Formatting" in the sidebar for more information. - -## Automated links - -If you want to use an automated system for managing links, see [Automated Links][mydoc_hyperlinks.html#automatedlinks]. This approach automatically creates a list of Markdown references to simplify linking. - -## Other instructions - -The content here is just a getting started guide only. For other details in working with the theme, see the various sections in the sidebar. - -{% include links.html %} +Please include any erroneous and/or outdated content (provide the URL), improvements suggestions. I will check this infrequently/bi-weekly to GitHub’s Issue tracker valid issues with the site to improve. \ No newline at end of file diff --git a/mozzletoff-wow-goldfarm-site.iml b/mozzletoff-wow-goldfarm-site.iml new file mode 100644 index 000000000..8021953ed --- /dev/null +++ b/mozzletoff-wow-goldfarm-site.iml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/pages/content-soon.md b/pages/content-soon.md new file mode 100644 index 000000000..5c05bef1c --- /dev/null +++ b/pages/content-soon.md @@ -0,0 +1,63 @@ +--- +title: This Farm will be released soon!! +keywords: documentation theme, jekyll, technical writers, help authoring tools, hat replacements +last_updated: Feb 22, 2020 +tags: [soon] +summary: "This WOW shuffle will be release soon" +sidebar: mydoc_sidebar +permalink: contentsoon.html +folder: wow-shuffles +--- + +# Overview +{% include tip.html content="This farm will be covered and released soon. Follow me on [twitter](https://twitter.com/mozzletoffWOW) where'll i'll announce each release when its added on to the site."%} + +## Google Sheets calculator +I am sharing my **Google Sheets** _(Excel.xls)_ to allow users to manipulate and pivot data as it varies server to server here: + +[Google Sheets calculator](www.twitch.tv/mozzletoff) + +## What can you earn + +Here is a list of the item's that you can earn: + +|Item|URL| +|-------|--------| +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| + +## Items involved in the Shuffle + +Here is a list of the item's needed in the shuffle: + +|Item|URL| +|-------|--------| +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| + +## Prerequisites for the Shuffle +In order to do this shuffle you must: + +* Get... +* Be... +* Profession of... +* What else? + +## Step by Steps explanation +In order to be able to do this shuffle, you must do the following: + +``` +1. First Step... +2. Second Step... +3. Third Step... +``` + +## Tips and Tricks +When doing this farms, be aware of + +## Reference Links + diff --git a/pages/helpful/profession-cooldown-macro-groups.md b/pages/helpful/profession-cooldown-macro-groups.md new file mode 100644 index 000000000..f792a96d6 --- /dev/null +++ b/pages/helpful/profession-cooldown-macro-groups.md @@ -0,0 +1,161 @@ +--- +title: Profession Cooldown Macro Groups +sidebar: mydoc_sidebar +permalink: profession-cooldown-macro-groups.html +folder: helpful +--- + + +# Overview +{% include tip.html content="This page will help you placer on your character toolbar Professional Cooldown Spells to make Daily, Weekly, Monthly etc cooldown easier to use on a regular basis vs favoriting or searching for them inside your professional tab. This can be setup through a macro for convenience logins craft mules to place on your toolbars. Follow me on [twitter](https://twitter.com/mozzletoffWOW) where I shall announce each release when its added on to the site."%} + +## Youtube Video explanation +I am sharing a Youtube video posted by **"Underrated54"** [here](https://www.youtube.com/watch?v=ZAdl8nB_pO4) which shows the macro creation process easier for readers unfamiliar with the steps. + +## Prerequisites for the Shuffle +In order to do this shuffle you must: + +* **Curseforge Addon**: idTip [here](https://www.curseforge.com/wow/addons/idtip) +* At least 1 profession below with appropriate cooldown unlocked to your personal character. +* Macro Room! 1 spell is 1 macro slot +* WOWHead DB Search [here](https://www.wowhead.com/spells?filter=109;157;0) for various Procession CD's based on Spelll type. You may apply various filters to drill down into what you are searching for. + +## Profession Cooldown Macro Groups + +Here is a cooldown groups you can use by profession groups. NOTE, this is a continued work in progress as the game releases more dailies. Check back here frequently or reach out via socials at the top for questions. AMA. Here: + +### Alchemy Profession CD's + +| Item |URL| MACRO | EXP | +|---------------------------------------|--------|-----------------------------------|-----------| +| Transmute: Herbs to Anchor |[Direct WOWHEAD Link](https://www.wowhead.com/spell=286547/transmute-herbs-to-anchors).| /run C_Spell.PickupSpell(286547) | WOD | +| Transmute: Meat to Pets |[Direct WOWHEAD Link](https://www.wowhead.com/spell=251808/transmute-meat-to-pet).| /run C_Spell.PickupSpell(251808) | WOD | +| Transmute: Pyrium Bar |[Direct WOWHEAD Link](https://www.wowhead.com/spell=80244/transmute-pyrium-bar).| /run C_Spell.PickupSpell(80244) | Cata | +| Transmute: Eternal Air |[Direct WOWHEAD Link](https://www.wowhead.com/wotlk/spell=53781/transmute-eternal-earth-to-air).| /run C_Spell.PickupSpell(53781) | WOD | +| Transmute: Meticulous Experimentation |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******)) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | + +### Blacksmithing Profession CD's + +| Item |URL| MACRO | EXP | +|-------------------------|--------|----------------------------------|-----| +| Truesteel Ingot |[Direct WOWHEAD Link](https://www.wowhead.com/spell=171690/truesteel-ingot).| /run C_Spell.PickupSpell(171690) | WOD | +| Balanced Trillium Ingot |[Direct WOWHEAD Link](https://www.wowhead.com/spell=143255/balanced-trillium-ingot).| /run C_Spell.PickupSpell(143255) | MOP | +| Lightning Steel Ingot |[Direct WOWHEAD Link](https://www.wowhead.com/spell=138646/lightning-steel-ingot).| /run C_Spell.PickupSpell(138646) | MOP | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | + +### Cooking Profession CD's + +| Item |URL| MACRO | EXP | +|----------------------------|--------|-----------------------------------|-----------| +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | + +### Enchanting Profession CD's + +| Item |URL| MACRO | EXP | +|----------------------------|--------|-----------------------------------|-----------| +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +|ITEM NAME HERE|[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | + +### Engineering Profession CD's + +| Item |URL| MACRO | EXP | +|------------------|--------|----------------------------------|-----| +| GearSpring Parts |[Direct WOWHEAD Link](https://www.wowhead.com/spell=169080/gearspring-parts).| /run C_Spell.PickupSpell(169080) | WOD | +| Jard's Peculiar Energy Source |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(139176) | MOP | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | + +### Inscription Profession CD's + +| Item |URL| MACRO | EXP | +|-------------------------------|--------|----------------------------------|-----| +| War Paints |[Direct WOWHEAD Link](https://www.wowhead.com/spell=169081/war-paints).| /run C_Spell.PickupSpell(169081) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | + +### Jewelcrafting Profession CD's + +| Item |URL| MACRO | EXP | +|------------------|--------|----------------------------------|-----------| +| Taladite Crystal |[Direct WOWHEAD Link](https://www.wowhead.com/spell=170700/taladite-crystal).| /run C_Spell.PickupSpell(170700) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | + +### Leatherworking Profession CD's + +| Item | URL | MACRO | EXP | +|------------------|--------------------------------------------------------------------------------|----------------------------------|-----------| +| Burnished Leather | [Direct WOWHEAD Link](https://www.wowhead.com/spell=171391/burnished-leather). | /run C_Spell.PickupSpell(171391) | WOD | +| Magnificent Hide | [Direct WOWHEAD Link](https://www.wowhead.com/spell=131865/magnificent-hide). | /run C_Spell.PickupSpell(140040) | WOD | +| ITEM NAME HERE | [Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem). | /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE | [Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem). | /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE | [Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem). | /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE | [Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem). | /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE | [Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem). | /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE | [Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem). | /run C_Spell.PickupSpell(******) | WOD | + +### Tailoring Profession CD's + +| Item |URL| MACRO | EXP | +|----------------|--------|-----------------------------------|-----------| +| HexWeave Cloth |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(168835) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | +| ITEM NAME HERE |[Direct WOWHEAD Link](https://www.wowhead.com/spell=139192/sky-golem).| /run C_Spell.PickupSpell(******) | WOD | + +## Step by Steps explanation +In order to be able to do this shuffle, you must do the following: + +``` +1. Find the Profession Cooldown Spell within your Profession (ie JC, Alchy, Tailor, etc). +2. Use the addon Spell ID idTIP to tell you the spell ID for the macro using Underrated54 Video guide. +3. Once you have the Spell ID for the profession CD you wish to cast, enter within the following macro: /run C_Spell.PickupSpell(******) +NOTE: It will look like this: /run PickupSpell(156587) + +``` + +## Tips and Tricks + +* Can use General Macro Tab to put the /run PickupSpell (******) macro to build across your Professional CD Macro Buttons for your tool bars. + +## Reference Links + +**"Underrated54"** [here](https://www.youtube.com/watch?v=ZAdl8nB_pO4) diff --git a/pages/mydoc/mydoc_about.md b/pages/mydoc/mydoc_about.md index 88a87d583..c658b5304 100644 --- a/pages/mydoc/mydoc_about.md +++ b/pages/mydoc/mydoc_about.md @@ -1,22 +1,70 @@ --- -title: About the theme's author +title: About the Website Creator keywords: documentation theme, jekyll, technical writers, help authoring tools, hat replacements -last_updated: July 3, 2016 +last_updated: November 23, 2019 tags: [getting_started] -summary: "I have used this theme for projects that I've worked on as a professional technical writer." +summary: "Who am I and Whats this site about?" sidebar: mydoc_sidebar permalink: mydoc_about.html folder: mydoc --- -My name is Tom Johnson, and I'm a technical writer, blogger, and podcaster based in San Jose, California. For more details, see my [technical writing blog](http://idratherbewriting.com) and my [course on API documentation](http://idratherbewriting.com/learnapidoc/). See [my blog's about page](http://idratherbewriting.com/aboutme/) for more details about me. +## **Quick Intro** +My name is **Derric Bartholomew** aka **Mozzletoff**. I am a Husband and Father of 3 first. +We currently live in the US on the east coast in Richmond VA. Previously, we're from south NJ right outside of Philly. +We moved down to VA for school and stayed for the jobs. +
-I have used this theme and variations of it for various documentation projects. This theme has undergone several major iterations, and now it's fairly stable and full of all the features that I need. You are welcome to use it for your documentation projects for free. +## **What kicked off gaming for you Mozz?** +First game played was Super Mario 3 on NES when I was 5. I got to watch my Mom and Dad play while my brother and I sat there for what was probably only 10 minutes but at the time felt like hours... -I think this theme does pretty much everything that you can do with something like OxygenXML, but without the constraints of structured authoring. Everything is completely open and changeable, so if you start tinkering around with the theme's files, you can break things. But it's completely empowering as well! +Second with Final Fantasy with my brother a dad. -With a completely open architecture and code base, you can modify the code to make it do exactly what you want, without having to jump through all kinds of confusing or proprietary code. +## **What games do you play online?** +I dont know... Warcraft/Gold Farming! Multiboxing x4 Diablo 3. I do play other Blizzard _free_ games in the store, League of Legends, Steam. -If there's a feature you need but it isn't available here, let me know and I might add it. Alternatively, if you fork the theme, I would love to see your modifications and enhancements. Thanks for using Jekyll. +## **What games do you play offline?** +Blizzard & Activision suite of games, Fornite, and Steam Library. Top 2 steam games? Divinity II & DOTA. + +[Here](https://drive.google.com/file/d/0B_KWu4K9rqXESTQwdEJROFlTa0k/view?usp=sharing) is a list of all the games available to Mozzle this very moment. + +## **Prior Service record** +I am prior service, having served 6 years _(honorable discharge)_ in the NJ & VA National Guard. Deployed 1 time over sea's and multiple times state side for Hurricane Katrina & 5+ multiple state emergencies as/when needed. I had enjoyed my service and went in with one goal in mind... college education and to serve my country. I did both. +
+
+ +## **Education** +I went to college for a BS in Criminal Justice with a minor in Business while working full time. It took me 5 years /cringe. The minor helps me more today than my major. I have various certification in AWS, Comp TIA _(still counts!)_, Scrum Master, Product Owner, SAFe concepts, you get the idea... +
+
+ +## **Current Career** +I now have a full time career working for an Enterprise in big banking working in Operations as a Production Support/AWS Engineer. I am a people manager for a medium sized team and currently a Product Owner for that team #Busy +
+
+ +## **Temporary Break until Real Life settles down & newborne gets healthy** +My main engagement to everyone use to be [Twitch TV](https://www.twitch.tv/mozzletoff) until the birth of my daughter back in june, born 2 months early. That is where I almost lost my wife and kiddo. Wife is absolutely fine now and we're in this hardship together <3 My daughter is who atm is stealing most of my attention physically, emotionally, spiritually, the list goes on - she's got it. +
+
+ +Ms Katelynn was born with a rare [lymphatic system](https://www.livescience.com/26983-lymphatic-system.html) disorder currently up in Children's Hospital of Philadelphia. It is so rare that there is not an official name & two years ago, would have been a death sentence... How ever CHOP calls its a Central Line malformation meaning her Lymphatic Central line does not connect to her vascular system / veins. Thus her lymphatic central line dilates pushing lymphatic fluid to her [subcutaneous layer](https://www.verywellhealth.com/subcutaneous-tissue-1068882)/3rd layer space in the skin causing severe edema. There are no studies to tell us next step but having leading doctors in lympathics work to thing of mechanical solutions to get her to properly draining we are told they will continue to work to do multiple [anastomosis](https://medlineplus.gov/ency/article/002231.htm) between her lymphatic & vascualar systems to allow proper drainage. Until then it is fighting infections chances, provide support for her heart rate, blood pressure management, respitory support as she intubated, constant pain management, child development concerns and limitation, blood cots from being bed ridden, nuerological concerns from constant sedition... the list can go on but you get the idea <3 As such I am working offline as if I click Go Live i'm likely to be in constant interuptions from phone calls or just upset due to the situation which isn't the live content I want to put out. Take care of yourself first folks - A L W A S Y S! +
+
+ +## **WOW Content Creator** +Let's switch gears a little bit... Outside of all that, I am a **World of Warcraft Goldfarming Content Creator** through Twitch, Twitter, Youtube, Instagram... you get the idea. I decided to create this website _(via Github, Github Pages, Ruby & Jekyll)_ to solve a simple problem. There is mountains... of Warcraft data... This website is to pool together all the Gold Farming related material for gold farmers to have a single, reliable website to find relevant gold farming information from various **Content Creators**. Then present that information the same templated way to easily located the desired info. +
+
+ + As I build this website and add on to it, I have a main focus in my mind... ease of navigation and easy to location information. That's it. I'll continue to collapse relevant, still useable content for WOW GoldFarming into the site with 100% credit called out to the content creator and their social media(s) which is the official source. +
+
+ +**Feedback is encouraged.** What am I missing? Layout sucks, should it be changed? What should be here that isn't? Youre missing active & relevant, no click baiting content creators along the top!! Let me know, I would love to hear about it. +
+
+ +## **Feedback** +Along the top right is your way to contact me by clicking on **Feedback**. You can also get in contact with me through my various [Social Medias](https://t.co/SRrJa1X9B7?amp=1). Thank YOU for taking the time to read through this and getting to know me a little bit more personally. -{% include links.html %} diff --git a/pages/mydoc/mydoc_about_ruby_gems_bundler.md b/pages/mydoc/mydoc_about_ruby_gems_bundler.md deleted file mode 100644 index b03bc2465..000000000 --- a/pages/mydoc/mydoc_about_ruby_gems_bundler.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -title: About Ruby, Gems, Bundler, and other prerequisites -tags: [getting_started, troubleshooting] -keywords: -summary: "Ruby is a programming language you must have on your computer in order to build Jekyll locally. Ruby has various gems (or plugins) that provide various functionality. Each Jekyll project usually requires certain gems." -sidebar: mydoc_sidebar -permalink: mydoc_about_ruby_gems_etc.html -folder: mydoc ---- - -## About Ruby - -Jekyll runs on Ruby, a programming language. You have to have Ruby on your computer in order to run Ruby-based programs like Jekyll. Ruby is installed on the Mac by default, but you must add it to Windows. - -## About Ruby Gems - -Ruby has a number of plugins referred to as "gems." Just because you have Ruby doesn't mean you have all the necessary Ruby gems that your program needs to run. Gems provide additional functionality for Ruby programs. There are thousands of [Rubygems](https://rubygems.org/) available for you to use. - -Some gems depend on other gems for functionality. For example, the Jekyll gem might depend on 20 other gems that must also be installed. - -Each gem has a version associated with it, and not all gem versions are compatible with each other. - -## Rubygem package managers - -[Bundler](http://bundler.io/) is a gem package manager for Ruby, which means it goes out and gets all the gems you need for your Ruby programs. If you tell Bundler you need the [jekyll gem](https://rubygems.org/gems/jekyll), it will retrieve all the dependencies on the jekyll gem as well -- automatically. - -Not only does Bundler retrieve the right gem dependencies, but it's smart enough to retrieve the right versions of each gem. For example, if you get the [github-pages](https://rubygems.org/gems/github-pages) gem, it will retrieve all of these other gems: - -``` -github-pages-health-check = 1.1.0 -jekyll = 3.0.3 -jekyll-coffeescript = 1.0.1 -jekyll-feed = 0.4.0 -jekyll-gist = 1.4.0 -jekyll-github-metadata = 1.9.0 -jekyll-mentions = 1.1.2 -jekyll-paginate = 1.1.0 -jekyll-redirect-from = 0.10.0 -jekyll-sass-converter = 1.3.0 -jekyll-seo-tag = 1.3.2 -jekyll-sitemap = 0.10.0 -jekyll-textile-converter = 0.1.0 -jemoji = 0.6.2 -kramdown = 1.10.0 -liquid = 3.0.6 -mercenary ~> 0.3 -rdiscount = 2.1.8 -redcarpet = 3.3.3 -RedCloth = 4.2.9 -rouge = 1.10.1 -terminal-table ~> 1. -``` - -See how Bundler retrieved version 3.0.3 of the jekyll gem, even though (as of this writing) the latest version of the jekyll gem is 3.1.2? That's because github-pages is only compatible up to jekyll 3.0.3. Bundler handles all of this dependency and version compatibility for you. - - Trying to keep track of which gems and versions are appropriate for your project can be a nightmare. This is the problem Bundler solves. As explained on [Bundler.io](http://bundler.io/): - -> Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed. -> -> Bundler is an exit from dependency hell, and ensures that the gems you need are present in development, staging, and production. Starting work on a project is as simple as bundle install. - -## Gemfiles - -Bundler looks in a project's "Gemfile" (no file extension) to see which gems are required by the project. The Gemfile lists the source and then any gems, like this: - -``` -source "https://rubygems.org" - -gem 'github-pages' -gem 'jekyll' -``` - -The source indicates the site where Bundler will retrieve the gems: [https://rubygems.org](https://rubygems.org). - -The gems it retrieves are listed separately on each line. - -Here no versions are specified. Sometimes gemfiles will specify the versions like this: - -``` -gem 'kramdown', '1.0' -``` - -This means Bundler should get version 1.0 of the kramdown gem. - -To specify a subset of versions, the Gemfile looks like this: - -``` -gem 'jekyll', '~> 2.3' -``` -The `~>` sign means greater than or equal to the *last digit before the last period in the number*. - -Here it will get any gem equal to 2.3 but less than 3.0. - -If it adds another digit, the scope is affected: - -``` -gem `jekyll`, `~>2.3.1' -``` - -This means to get any gem equal to 2.3.1 but less than 2.4. - -If it looks like this: - -``` -gem 'jekyll', '~> 3.0', '>= 3.0.3' -``` - -This will get any Jekyll gem between versions 3.0 and up to 3.0.3. - -See this [Stack Overflow post](http://stackoverflow.com/questions/5170547/what-does-tilde-greater-than-mean-in-ruby-gem-dependencies) for more details. - -## Gemfile.lock - -After Bundler retrieves and installs the gems, it makes a detailed list of all the gems and versions it has installed for your project. The snapshot of all gems + versions installed is stored in your Gemfile.lock file, which might look like this: - -``` -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 - -BUNDLED WITH - 1.11.2 -``` - -You can always delete the Gemlock file and run Bundle install again to get the latest versions. You can also run `bundle update`, which will ignore the Gemlock file to get the latest versions of each gem. - -To learn more about Bundler, see [Bundler's Purpose and Rationale](http://bundler.io/rationale.html). - -{% include links.html %} diff --git a/pages/mydoc/mydoc_adding_tooltips.md b/pages/mydoc/mydoc_adding_tooltips.md deleted file mode 100644 index 52a673c19..000000000 --- a/pages/mydoc/mydoc_adding_tooltips.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Tooltips -tags: [formatting] -keywords: popovers, tooltips, user interface text, glossaries, definitions -last_updated: July 3, 2016 -summary: "You can add tooltips to any word, such as an acronym or specialized term. Tooltips work well for glossary definitions, because you don't have to keep repeating the definition, nor do you assume the reader already knows the word's meaning." -sidebar: mydoc_sidebar -permalink: mydoc_adding_tooltips.html -folder: mydoc ---- - -## Creating tooltips -Because this theme is built on Bootstrap, you can simply use a specific attribute on an element to insert a tooltip. - -Suppose you have a glossary.yml file inside your \_data folder. You could pull in that glossary definition like this: - -{% raw %} -```html -Jekyll is my favorite tool for building websites. -``` -{% endraw %} - -This renders to the following: - -Jekyll is my favorite tool for building websites. - -{% include links.html %} diff --git a/pages/mydoc/mydoc_alerts.md b/pages/mydoc/mydoc_alerts.md deleted file mode 100644 index da1c3f932..000000000 --- a/pages/mydoc/mydoc_alerts.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -title: Alerts -tags: [formatting] -keywords: notes, tips, cautions, warnings, admonitions -last_updated: July 3, 2016 -summary: "You can insert notes, tips, warnings, and important alerts in your content. These notes make use of Bootstrap styling and are available through data references such as site.data.alerts.note." -sidebar: mydoc_sidebar -permalink: mydoc_alerts.html -folder: mydoc ---- - -## About alerts - -Alerts are little warnings, info, or other messages that you have called out in special formatting. In order to use these alerts or callouts, reference the appropriate value stored in the alerts.yml file as described in the following sections. - -## Alerts - -Similar to [inserting images][mydoc_images], you insert alerts through various includes that have been developed. These includes provide templates through which you pass parameters to easily populate the right HTML code. - -``` -{%raw%}{% include note.html content="This is my note. All the content I type here is treated as a single paragraph." %}{% endraw%} -``` - -Here's the result: - -{% include note.html content="This is my note. All the content I type here is treated as a single paragraph." %} - -With alerts, there's just one include property: - -| Property | description | -|-------|--------| -| content | The content for the alert. | - -## Using block level tags inside the alerts {#blockleveltags} - -If you need multiple paragraphs, enter `

` tags. This is because block level tags aren't allowed here, as Kramdown is processing the content as Markdown despite the fact that the content is surrounded by HTML tags. Here's an example with a break: - -``` -{%raw%}{% include note.html content="This is my note. All the content I type here is treated as a single paragraph.

Now I'm typing on a new line." %}{% endraw%} -``` - -Here's the result: - -{% include note.html content="This is my note. All the content I type here is treated as a single paragraph.

Now I'm typing on a new line." %} - -The include uses `markdown="span"` as an attribute, which means kramdown will process the entire `content` as a span. You can't use block elements such as `p` or `div` or `pre`. If you need these elements, you can either manually surround the content with the HTML from the include, or you can use these tags: - -``` -{% raw %}{{site.data.alerts.note}} -

This is my note.

-
-def foo(x):
-    return x+1 -
-{{site.data.alerts.end}}{% endraw %} -``` - -**Result:** - -{{site.data.alerts.note}} -

This is my note.

-
-def foo(x):
-    return x+1 -
-{{site.data.alerts.end}} - -The same Bootstrap code from the alert is stored in yaml files inside the \_data folder. (This was how I previously implemented this code, but since this method was prone to error and didn't trigger any build warnings or failures when incorrectly coded, I changed the approach to use includes instead.) - -## Types of alerts available - -There are four types of alerts you can leverage: - -* note.html -* tip.html -* warning.html -* important.html - -They function the same except they have a different color, icon, and alert word. You include the different types by selecting the include template you want. Here are samples of each alert: - -{% include note.html content="This is my note." %} - -{% include tip.html content="This is my tip." %} - -{% include warning.html content="This is my warning." %} - -{% include important.html content="This is my important info." %} - -These alerts leverage includes stored in the \_include folder. The `content` option is a parameter that you pass to the include. In the include, the parameter is passed like this: - -``` -{% raw %} -``` - -The content in `content="This is my note."` gets inserted into the `{% raw %}{{include.content}}}{% endraw %}` part of the template. You can follow this same pattern to build additional includes. See this [Jekyll screencast on includes](http://jekyll.tips/jekyll-casts/includes/) or [this screencast](https://www.youtube.com/watch?v=TJcn_PJ2100) for more information. - -## Callouts - -There's another type of callout available called callouts. This format is typically used for longer callout that spans more than one or two paragraphs, but really it's just a stylistic preference whether to use an alert or callout. - -Here's the syntax for a callout: - -``` -{% raw %}{% include callout.html content="This is my callout. It has a border on the left whose color you define by passing a type parameter. I typically use this style of callout when I have more information that I want to share, often spanning multiple paragraphs. " type="primary" %} {% endraw %} -``` - -Here's the result: - -{% include callout.html content="This is my callout. It has a border on the left whose color you define by passing a type parameter. I typically use this style of callout when I have more information that I want to share, often spanning multiple paragraphs." type="primary" %} - -The available properties for callouts are as follows: - -| Property | description | -|-------|--------| -| content | The content for the callout. | -| type | The style for the callout. Options are `danger`, `default`, `primary`, `success`, `info`, and `warning`.| - -The types just define the color of the left border. Each of these callout types get inserted as a class name in the callout template. These class names correspond with styles in Bootstrap. These classes are common Bootstrap class names whose style attributes differ depending on your Bootstrap theme and style definitions. - -Here's an example of each different type of callout: - -{% include callout.html content="This is my **danger** type callout. It has a border on the left whose color you define by passing a type parameter." type="danger" %} - -{% include callout.html content="This is my **default** type callout. It has a border on the left whose color you define by passing a type parameter." type="default" %} - -{% include callout.html content="This is my **primary** type callout. It has a border on the left whose color you define by passing a type parameter." type="primary" %} - -{% include callout.html content="This is my **success** type callout. It has a border on the left whose color you define by passing a type parameter." type="success" %} - -{% include callout.html content="This is my **info** type callout. It has a border on the left whose color you define by passing a type parameter." type="info" %} - -{% include callout.html content="This is my **warning** type callout. It has a border on the left whose color you define by passing a type parameter." type="warning" %} - -Now that in contrast to alerts, callouts don't include the alert word (note, tip, warning, or important). You have to manually include it inside `content` if you want it. - -To include paragraph breaks, use `

` inside the callout: - -``` -{% raw %}{% include callout.html content="**Important information**: This is my callout. It has a border on the left whose color you define by passing a type parameter. I typically use this style of callout when I have more information that I want to share, often spanning multiple paragraphs.

Here I am starting a new paragraph, because I have lots of information to share. You may wonder why I'm using line breaks instead of paragraph tags. This is because Kramdown processes the Markdown here as a span rather than a div (for whatever reason). Be grateful that you can be using Markdown at all inside of HTML. That's usually not allowed in Markdown syntax, but it's allowed here." type="primary" %} {% endraw %} -``` - -Here's the result: - -{% include callout.html content="**Important information**: This is my callout. It has a border on the left whose color you define by passing a type parameter. I typically use this style of callout when I have more information that I want to share, often spanning multiple paragraphs.

Here I am starting a new paragraph, because I have lots of information to share. You may wonder why I'm using line breaks instead of paragraph tags. This is because Kramdown processes the Markdown here as a span rather than a div (for whatever reason). Be grateful that you can be using Markdown at all inside of HTML. That's usually not allowed in Markdown syntax, but it's allowed here." type="primary" %} - -## Use Liquid variables inside parameters with includes - -Suppose you have a product name or some other property that you're storing as a variable in your configuration file (\_config.yml), and you want to use this variable in the `content` parameter for your alert or callout. You will get an error if you use Liquid syntax inside a include parameter. For example, this syntax will produce an error: - -``` -{%raw%}{% include note.html content="The {{site.company}} is pleased to announce an upcoming release." %}{%endraw%} -``` - -The error will say something like this: - -``` -Liquid Exception: Invalid syntax for include tag. File contains invalid characters or sequences: ... Valid syntax: {%raw%}{% include file.ext param='value' param2='value' %}{%endraw%} -``` - -To use variables in your include parameters, you must use the "variable parameter" approach. First you use a `capture` tag to capture some content. Then you reference this captured tag in your include. Here's an example. - -In my site configuration file (\_congfig.yml), I have a property called `company_name`. - -```yaml -company_name: Your company -``` - -I want to use this variable in my note include. - -First, before the note I capture the content for my note's include like this: - -```liquid -{%raw%}{% capture company_note %}The {{site.company_name}} company is pleased to announce an upcoming release.{% endcapture %}{%endraw%} -``` - -Now reference the `company_note` in your `include` parameter like this: - -``` -{%raw%}{% include note.html content=company_note}{%endraw%} -``` - -Here's the result: - -{% capture company_note %}The {{site.company_name}} is pleased to announce an upcoming release.{% endcapture %} -{% include note.html content=company_note %} - -Note the omission of quotation marks with variable parameters. - -Also note that instead of storing the variable in your site's configuration file, you could also put the variable in your page's frontmatter. Then instead of using `{%raw%}{{site.company_name}}{%endraw%}` you would use `{%raw%}{{page.company_name}}{%endraw%}`. - -## Markdown inside of callouts and alerts - -You can use Markdown inside of callouts and alerts, even though this content actually gets inserted inside of HTML in the include. This is one of the advantages of kramdown Markdown. The include template has an attribute of `markdown="span"` that allows for the processor to parse Markdown inside of HTML. - -## Validity checking - -If you have some of the syntax wrong with an alert or callout, you'll see an error when Jekyll tries to build your site. The error may look like this: - -``` -{% raw %}Liquid Exception: Invalid syntax for include tag: content="This is my **info** type callout. It has a border on the left whose color you define by passing a type parameter. type="info" Valid syntax: {% include file.ext param='value' param2='value' %} in mydoc/mydoc_alerts.md {% endraw %} -``` - -These errors are a good thing, because it lets you know there's an error in your syntax. Without the errors, you may not realize that you coded something incorrectly until you see the lack of alert or callout styling in your output. - -In this case, the quotation marks aren't set correctly. I forgot the closing quotation mark for the content parameter include. - -## Blast a warning to users on every page - -If you want to blast a warning to users on every page, add the alert or callout to the \_layouts/page.html page right below the frontmatter. Every page using the page layout (all, by default) will show this message. - -{% include links.html %} diff --git a/pages/mydoc/mydoc_atom_text_editor.md b/pages/mydoc/mydoc_atom_text_editor.md deleted file mode 100644 index 6547b99d8..000000000 --- a/pages/mydoc/mydoc_atom_text_editor.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Atom Text Editor -keywords: atom, text editor, -last_updated: March 20, 2016 -summary: "Atom is a free text editor that is a favorite tool of many writers because it is free. This page provides some tips for using Atom." -sidebar: mydoc_sidebar -permalink: mydoc_atom_text_editor.html -folder: mydoc ---- - -If you haven't downloaded [Atom](https://atom.io/), download and install it. Use this as your editor when working with Jekyll. The syntax highlighting is probably the best among the available editors, as it was designed with Jekyll-authoring in mind. However, if you prefer Sublime Text, WebStorm, or some other editor, you can also use that. - -Customize the invisibles and tab spacing in Atom: - -1. Go to **Atom > Preferences**. -2. On the **Settings** tab, keep the default options but also select the following: - * **Show Invisibles** - * **Soft Wrap** - * For the **Tab Length**, type **4**. - * For the **Tab Type**, select **soft**. - -Turn off auto-complete: - -1. Go to **Atom > Preferences**. -2. Click the **Packages** tab. -3. Search for **autocomplete-plus**. -4. Disable the autocomplete package. - -### Atom Shortcuts - -* **Cmd + T**: Find file -* **Cmd + Shift + F**: Find across project -* **Cmd + Alt + S**: Save all - -(For Windows, replace "Cmd" with "Ctrl".) diff --git a/pages/mydoc/mydoc_build_arguments.md b/pages/mydoc/mydoc_build_arguments.md deleted file mode 100644 index 6b5593b9b..000000000 --- a/pages/mydoc/mydoc_build_arguments.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Build arguments -tags: [publishing] -keywords: building, serving, serve, build -last_updated: July 3, 2016 -summary: "You use various build arguments with your Jekyll project. You can also create shell scripts to act as shortcuts for long build commands. You can store the commands in iTerm as profiles as well." -sidebar: mydoc_sidebar -permalink: mydoc_build_arguments.html -folder: mydoc ---- - -## How to build Jekyll sites - -The normal way to build the Jekyll site is through the build command: - -``` -jekyll build -``` - -To build the site and view it in a live server so that Jekyll rebuilds that site each time you make a change, use the `serve` command: - -``` -jekyll serve -``` - -By default, the \_config.yml in the root directory will be used, Jekyll will scan the current directory for files, and the folder `_site` will be used as the output. You can customize these build commands like this: - -``` -jekyll serve --config configs/myspecialconfig.yml --destination ../doc_outputs -``` - -Here the `configs/myspecialconfig.yml` file is used instead of `_config.yml`. The destination directory is `../doc_outputs`, which would be one level up from your current directory. - -## Shortcuts for the build arguments - -If you have a long build argument and don't want to enter it every time in Jekyll, noting all your configuration details, you can create a shell script and then just run the script. Simply put the build argument into a text file and save it with the .sh extension (for Mac) or .bat extension (for Windows). Then run it like this: - -``` -. myscript.sh -``` - -My preference is to add the scripts to profiles in iTerm. See [iTerm Profiles][mydoc_iterm_profiles] for more details. - -## Stop a server - -When you're done with the preview server, press **Ctrl+C** to exit out of it. If you exit iTerm or Terminal without shutting down the server, the next time you build your site, or if you build multiple sites with the same port, you may get a server-already-in-use message. - -You can kill the server process using these commands: - -``` -ps aux | grep jekyll -``` - -Find the PID (for example, it looks like "22298"). - -Then type `kill -9 22298` where "22298" is the PID. - -To kill all Jekyll instances, use this: - -``` -kill -9 $(ps aux | grep '[j]ekyll' | awk '{print $2}') -``` - -I recommend creating a profile in iTerm that stores this command. Here's what the iTerm settings look like: - -{% include image.html file="killalljekyll.png" caption="iTerm profile settings to kill all Jekyll" %} - -{% include links.html %} diff --git a/pages/mydoc/mydoc_build_scripts.md b/pages/mydoc/mydoc_build_scripts.md deleted file mode 100644 index aa1f564ef..000000000 --- a/pages/mydoc/mydoc_build_scripts.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -title: 10. Configure the build scripts -tags: - - publishing -keywords: "build scripts, generating outputs, building, publishing" -last_updated: "November 30, 2016" -summary: "You need to customize the build scripts. These script automate the publishing of your PDFs and web outputs through shell scripts on the command line." -series: "Getting Started" -weight: 10 -sidebar: mydoc_sidebar -permalink: mydoc_build_scripts.html -folder: mydoc ---- - -{% include custom/getting_started_series.html %} - -## About the build scripts - -The mydoc project has 5 build scripts and a script that runs them all. These scripts will require a bit of detail to configure. Every team member who is publishing on the project should set up their folder structure in the way described here. - -## Get Set Up - -Your command-line terminal opens up to your user name (for example, `Users/tjohnson`). I like to put all of my projects from repositories into a subfolder under my username called "projects." This makes it easy to get to the projects from the command line. You can vary from the project organization I describe here, but following the pattern I outline will make configuration easier. - -To set up your projects: - -1. Set up your Jekyll theme in a folder called "docs." All of the source files for every project the team is working on should live in this directory. Most likely you already either downloaded or cloned the jekyll-documentation-theme. Just rename the folder to "docs" and move it into the projects folder as shown here. -2. In the same root directory where the docs folder is, create another directory parallel to docs called doc_outputs.  - - Thus, your folder structure should be something like this: - - ``` - projects - - docs - - doc_outputs - ``` - - The docs folder contains the source of all your files, while the doc_outputs contains the site outputs. - -## Configure the Build Scripts - -For the mydocs project, you'll see a series of build scripts for each project. There are 5 build scripts, described in the following sections. Note that you really only need to run the last one, e.g., mydoc_all.sh, because it runs all of the build scripts. But you have to make sure each script is correctly configured so that they all build successfully. - -{% include tip.html content="In the descriptions of the build scripts, \"mydoc\" is used as the sample project. Substitute in whatever your real project name is." %} - -### mydoc_1_multiserve_pdf.sh - -Here's what this script looks like: - -``` -echo 'Killing all Jekyll instances' -kill -9 $(ps aux | grep '[j]ekyll' | awk '{print $2}') -clear - - -echo "Building PDF-friendly HTML site for Mydoc Writers ..." -jekyll serve --detach --config configs/mydoc/config_writers.yml,configs/mydoc/config_writers_pdf.yml -echo "done" - -echo "Building PDF-friendly HTML site for Mydoc Designers ..." -jekyll serve --detach --config configs/mydoc/config_designers.yml,configs/mydoc/config_designers_pdf.yml -echo "done" - -echo "All done serving up the PDF-friendly sites. Now let's generate the PDF files from these sites." -echo "Now run . mydoc_2_multibuild_pdf.sh" -``` - -After killing all existing Jekyll instances that may be running, this script serves up a PDF friendly version of the docs (in HTML format) at the destination specified in the configuration file. - -Each of your configuration files needs to have a destination like this: `../doc_outputs/mydoc/adtruth-java`. That is, the project should build in the doc_outputs folder, in a subfolder that matches the project name. - -The purpose of this script is to make a version of the HTML output that is friendly to the Prince XML PDF generator. This version of the output strips out the sidebar, topnav, and other components to just render a bare-bones HTML representation of the content. - -Customize the script with your own PDF configuration file names. - -### mydoc_2_multibuild_pdf.sh - -Here's what this script looks like: - -``` -# Doc Writers -echo "Building the Mydoc Writers PDF ..." -prince --javascript --input-list=../doc_outputs/mydoc/writers-pdf/prince-file-list.txt -o mydoc/files/mydoc_writers_pdf.pdf; -echo "done" - -# Doc Designers -echo "Building Mydoc Designers PDF ..." -prince --javascript --input-list=../doc_outputs/mydoc/designers-pdf/prince-file-list.txt -o mydoc/files/mydoc_designers_pdf.pdf; -echo "done" - -echo "All done building the PDFs!" -echo "Now build the web outputs: . mydoc_3_multibuild_web.sh" -``` - -This script builds the PDF output using the Prince command. The script reads the location of the prince-file-list.txt file in the PDF friendly output folder (as defined in the previous script) and builds a PDF. - -The Prince build command takes an input parameter (`--input-list=`) that lists where all the pages are (prince-file-list.txt), and then combines all the pages into a PDF, including cross-references and other details. The Prince build command also specifies the output folder (`-o`). - -The prince-file-list.txt file (which simply contains a list of URLs to HTML pages) is generated by iterating through the table of contents (mydoc_sidebar.yml) and creating a list of URLs. You can open up prince-file-list.txt in the doc output to ensure that it has a list of absolute URLs (not relative) in order for Prince to build the PDF. - -This is one way the configuration file for the PDF-friendly output differs from the HTML output. (If the PDF isn't building, it's because the prince-file-list.txt in the output is empty or it contains relative URLs.) - -The Prince build script puts the output PDF into the mydoc/mydoc/files directory. Now you can reference the PDF file in your HTML site. For example, on the homepage you can allow people to download a PDF of the content at files/adtruth_dotnet_pdf.pdf. - -### mydoc_3_multibuild_web.sh - -Here's what this script looks like: - -``` -kill -9 $(ps aux | grep '[j]ekyll' | awk '{print $2}') -clear - -echo "Building Mydoc Writers website..." -jekyll build --config configs/doc/config_writers.yml -# jekyll serve --config configs/doc/config_writers.yml -echo "done" - -echo "Building Mydoc Designers website..." -jekyll build --config configs/doc/config_designers.yml -# jekyll serve --config configs/doc/config_designers.yml -echo "done" - -echo "All finished building all the web outputs!!!" -echo "Now push the builds to the server with . mydoc_4_publish.sh" -``` - -After killing all Jekyll instances, this script builds an HTML version of the projects and puts the output into the doc_outputs folder. This is the version of the content that users will mainly navigate. Since the sites are built with relative links, you can browse to the folder on your local machine, double-click the index.html file, and see the site. - -The `#` part below the `jekyll build` commands contains a serve command that is there for mere convenience in case you want to serve up just one site among many that you're building. For example, if you don't want to build everything — just one site — you might just use the serve command instead. (Anything after # in a YAML file comments out the content.) - -### mydoc_4_publish.sh - -Here's what this script looks like: - -``` -echo "remove previous directory and any subdirectories without a warning prompt" -ssh yourusername@yourdomain.com 'rm -rf /var/www/html/yourpublishingdirectory' - -echo "push new content into the remote directory" -scp -r -vrC ../mydoc_outputs/doc-writers yourusername@yourdomain:/var/www/html/yourpublishingdirectory - -echo "All done pushing doc outputs to the server" - -``` - -This script assumes you're publishing content onto a Linux server. - -Change `yourusername` to your own user name. - -This script first removes the project folder on /var/www/html/yourpublishingdirectory site and then transfers the content from doc_outputs over to the appropriate folder in /var/www/html/yourpublishingdirectory. - -Note that the delete part of the script (`rm -rf`) works really well. It annihilates a folder in a heartbeat and doesn't give you any warning prompts, so make sure you have it set up correctly. - -Also, in case you haven't set up the SSH publishing without a password, see [Getting around the password prompts in SCP][mydoc_no_password_prompts_scp]. Otherwise the script will stop and ping you to enter your password for each directory it transfers. - -### (Optional) Push to repositories - -This script isn't included in the theme, but you might optionally decide to push the built sites into another github repository. For example, if you're using Cloud Cannon to deploy your sites, you can have Cloud Cannon read files from a specific Github repository. - -Here's what this script looks like: - -``` -cd doc_outputs/mydoc/designers -git add --all -git commit -m "publishing latest version of docs" -git push -echo "All done pushing to Github" -echo "Here's the link to download the guides..." -cd ../../docs -``` - -This final script simply makes a commit into a Github repo for one of your outputs. - -The doc_outputs/mydoc/designers contains the site output from mydoc, so when you push content from this folder into Github, you're actually pushing the HTML site output into Github, not the mydoc source files. - -Your delivery team can also grab the site output from these repos. After downloading it, the person unzips the folder and sees the website folders inside. - -### mydoc_all.sh - -Here's what this script looks like: - -``` -. deviceinsight_1_multiserve_pdf.sh; . deviceinsight_2_multibuild_pdf.sh; . deviceinsight_3_multibuild_web.sh; . deviceinsight_4_publish.sh; -``` - -This script simply runs the other scripts. To sequence the commands, you just separate them with semicolons. (If you added the optional script, be sure to include it here.) - -After you've configured all the scripts, you can run them all by running `. mydoc_all.sh`. You might want to run this script at lunchtime, since it may take about 10 to 20 minutes to completely build the scripts. But note that since everything is now automated, you don't have to do anything at all after executing the script. After the script finishes, everything is published and in the right location. - - -## Test out the scripts - -After setting up and customizing the build scripts, run a few tests to make sure everything is generating correctly. Getting this part right is somewhat difficult and may likely require you to tinker around with the scripts a while before it works flawlessly. - -{% include custom/getting_started_series_next.html %} - -{% include links.html %} diff --git a/pages/mydoc/mydoc_code_samples.md b/pages/mydoc/mydoc_code_samples.md deleted file mode 100644 index fb6fef333..000000000 --- a/pages/mydoc/mydoc_code_samples.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Code samples -tags: [formatting] -keywords: dcode samples syntax highlighting -last_updated: July 3, 2016 -datatable: true -summary: "You can use fenced code blocks with the language specified after the first set of backtick fences." -sidebar: mydoc_sidebar -permalink: mydoc_code_samples.html -folder: mydoc ---- - -## Code Samples - -Use fenced code blocks with the language specified, like this: - - ```js - console.log('hello'); - ```` - -**Result:** - -```js -console.log('hello'); -``` - -For the list of supported languages you can use (similar to `js` for JavaScript), see [Supported languages](https://github.com/jneen/rouge/wiki/list-of-supported-languages-and-lexers). diff --git a/pages/mydoc/mydoc_collections.md b/pages/mydoc/mydoc_collections.md deleted file mode 100644 index f1c408904..000000000 --- a/pages/mydoc/mydoc_collections.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Collections -tags: [content_types] -keywords: groups, api, structure -last_updated: July 3, 2016 -summary: "Collections are useful if you want to loop through a special folder of pages that you make available in a content API. You could also use collections if you have a set of articles that you want to treat differently from the other content, with a different layout or format." -sidebar: mydoc_sidebar -permalink: mydoc_collections.html -folder: mydoc ---- - -## What are collections -Collections are custom content types different from pages and posts. You might create a collection if you want to treat a specific set of articles in a unique way, such as with a custom layout or listing. For more detail on collections, see [Ben Balter's explanation of collections here](https://ben.balter.com/2015/02/20/jekyll-collections/). - -## Create a collection -To create a collection, add the following in your configuration file: - -``` -collections: - tooltips: - output: true -``` - -In this example, "tooltips"" is the name of the collection. - -## Interacting with collections - -You can interact with collections by using the `site.collectionname` namespace, where `collectionname` is what you've configured. In this case, if I wanted to loop through all tooltips, I would use `site.tooltips` instead of `site.pages` or `site.posts`. - -See [Collections in the Jekyll documentation](http://jekyllrb.com/docs/collections/) for more information. - -## How to use collections - -I haven't found a huge use for collections in normal documentation. However, I did find a use for collections in generating a tooltip file that would be used for delivering tooltips to a user interface from text files in the documentation. See [Help APIs and UI tooltips][mydoc_help_api] for details. - -## Video tutorial on collections - -See this [video tutorial on Jekyll.tips](http://jekyll.tips/jekyll-casts/introduction-to-collections/) for more details on collections. - -{% include links.html %} diff --git a/pages/mydoc/mydoc_commenting_on_files.md b/pages/mydoc/mydoc_commenting_on_files.md deleted file mode 100644 index 7d7484499..000000000 --- a/pages/mydoc/mydoc_commenting_on_files.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Commenting on files -tags: - - navigation -keywords: "annotations, comments, feedback" -last_updated: "November 30, 2016" -summary: "You can add a button to your pages that allows people to add comments." -sidebar: mydoc_sidebar -permalink: mydoc_commenting_on_files.html -folder: mydoc ---- - -## About the review process - -If you're using the doc as code approach, you might also consider using the same techniques for reviewing the doc as people use in reviewing code. This approach will involve using Github to edit the files. - -There's an Edit me button on each page on this theme. This button allows collaborators to edit the content on Github. - -Here's the code for that button on the page.html layout for GitHub: - - -``` -{% raw %}{% if site.github_editme_path %} - - Edit me - -{% endif %}{% endraw %} -``` - -and here for GitLab: - - -``` -{% raw %}{% if site.gitlab_editme_path %} - - Edit me - -{% endif %}{% endraw %} -``` - -In your configuration file, edit the value for `github_editme_path` (or for Gitlab: `gitlab_editme_path`). For example, you might create a branch called "reviews" on your Github repo. Then you would add something like this in your configuration file for the 'github_editme_path': tomjoht/documentation-theme-jekyll/edit/reviews. Here "tomjoht" is my github account name. The repo name is "documentation-theme-jekyll". The "reviews" name is the branch. - -To suppress this button, comment out the `github_editme_path` in the \_config.yml file. - -## Add reviewers as collaborators - -If you want people to collaborate on your project so that their edits get committed to a branch on your project, you need to add them as collaborators. For your Github repo, click **Settings** and add the collaborators on the Collaborators tab using their Github usernames. - -If you don't want to allow anyone to commit to your Github branch, don't add the reviewers as collaborators. When someone makes an edit, Github will fork the theme. The person's edit then will appear as a pull request to your repo. You can then choose to merge the change indicated in the pull or not. - -{% include note.html content="When you process pull requests, you have to accept everything or nothing. You can't pick and choose which changes you'll merge. Therefore you'll probably want to edit the branch you're planning to merge or ask the contributor to make some changes to the fork before processing the pull request." %} - - -## Workflow - -Users will make edits in your "reviews" branch (or whatever you want to call it). You can then commit those edits as you make updates. - -When you're finished making all updates in the branch, you can merge the branch into the master. - -Note that if you're making updates online, those updates will be out of sync with any local edits. - -{% include warning.html content="Don't make edits both online using Github's browser-based interface AND offline on your local machine using your local tools. When you try to push from your local, you'll likely get a merge conflict error. Instead, make sure you do a pull and update on your local after making any edits online." %} - -## Prose.io - - Prose.io is an overlay on Github that would allow people to make comments in an easier interface. If you simply go to [prose.io](http://prose.io), it asks to authorize your Github account, and so it will read files directly from Github but in the Prose.io interface. - - {% include links.html %} diff --git a/pages/mydoc/mydoc_conditional_logic.md b/pages/mydoc/mydoc_conditional_logic.md deleted file mode 100644 index cc8d86d0f..000000000 --- a/pages/mydoc/mydoc_conditional_logic.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: Conditional logic -tags: [single_sourcing] -keywords: if else logic, conditions, conditional attributes, conditional filtering -last_updated: July 3, 2016 -summary: "You can implement advanced conditional logic that includes if statements, or statements, unless, and more. This conditional logic facilitates single sourcing scenarios in which you're outputting the same content for different audiences." -sidebar: mydoc_sidebar -permalink: mydoc_conditional_logic.html -folder: mydoc ---- - -## About Liquid and conditional statements -If you want to create different outputs for different audiences, you can do all of this using a combination of Jekyll's Liquid markup and values in your configuration file. This is how I previously configured the theme. I had different configuration files for each output. Each configuration file specified different values for product, audience, version, and so on. Then I had different build processes that would leverage the different configuration files. It seemed like a perfect implementation of DITA-like techniques with Jekyll. - -But I soon found that having lots of separate outputs for a project was undesirable. If you have 10 different outputs that have different nuances for different audiences, it's hard to manage and maintain. In this latest version of the theme, I consolidated all information into the same output to explicitly do away with the multi-output approach. - -As such, the conditional logic won't have as much play as it previously did. Instead of conditions, you'll probably want to incorporate [navtabs](mydoc_navtabs) to split up the information. - -However, you can still of course use conditional logic as needed. - -{% include tip.html content="Definitely check out [Liquid's documentation](http://docs.shopify.com/themes/liquid-documentation/basics) for more details about how to use operators and other liquid markup. The notes here are a small, somewhat superficial sample from the site." %} - -## Where to store filtering values - -You can filter content based on values that you have set either in your page's frontmatter, a config file, or in a file in your \_data folder. If you set the attribute in your config file, you need to restart the Jekyll server to see the changes. If you set the value in a file in your \_data folder or page frontmatter, you don't need to restart the server when you make changes. - -## Conditional logic based on config file value - -Here's an example of conditional logic based on a value in the page's frontmatter. Suppose you have the following in your frontmatter: - -``` -platform: mac -``` - -On a page in my site (it can be HTML or markdown), you can conditionalize content using the following: - -{% raw %} -```liquid -{% if page.platform == "mac" %} -Here's some info about the Mac. -{% elsif page.platform == "windows" %} -Here's some info about Windows ... -{% endif %} -``` -{% endraw %} - -This uses simple `if-elsif` logic to determine what is shown (note the spelling of `elsif`). The `else` statement handles all other conditions not handled by the `if` statements. - -Here's an example of `if-else` logic inside a list: - -{% raw %} -```liquid -To bake a casserole: - -1. Gather the ingredients. -{% if page.audience == "writer" %} -2. Add in a pound of meat. -{% elsif page.audience == "designer" %} -3. Add in an extra can of beans. -{% endif %} -3. Bake in oven for 45 min. -``` -{% endraw %} - -You don't need the `elsif` or `else`. You could just use an `if` (but be sure to close it with `endif`). - -## Or operator - -You can use more advanced Liquid markup for conditional logic, such as an `or` command. See [Shopify's Liquid documentation](http://docs.shopify.com/themes/liquid-documentation/basics/operators) for more details. - -For example, here's an example using `or`: - -{% raw %} -```liquid -{% if page.audience contains "vegan" or page.audience == "vegetarian" %} - Then run this... -{% endif %} -``` -{% endraw %} - -Note that you have to specify the full condition each time. You can't shorten the above logic to the following: - -{% raw %} -```liquid -{% if page.audience contains "vegan" or "vegetarian" %} - // run this. -{% endif %} -``` -{% endraw %} - -This won't work. - -## Unless operator - -You can also use `unless` in your logic, like this: - -{% raw %} -```liquid -{% unless site.output == "pdf" %} -...do this -{% endunless %} -``` -{% endraw %} - -When figuring out this logic, read it like this: "Run the code here *unless* this condition is satisfied."." - -Don't read it the other way around or you'll get confused. (It's *not* executing the code only if the condition is satisfied.) - -## Storing conditions in the \_data folder - -Here's an example of using conditional logic based on a value in a data file: - -{% raw %} -```liquid -{% if site.data.options.output == "alpha" %} -show this content... -{% elsif site.data.options.output == "beta" %} -show this content... -{% else %} -this shows if neither of the above two if conditions are met. -{% endif %} -``` -{% endraw %} - -To use this, I would need to have a \_data folder called options where the `output` property is stored. - -## Specifying the location for \_data - -You can also specify a `data_source` for your data location in your configuration file. Then you aren't limited to simply using `_data` to store your data files. - -For example, suppose you have 2 projects: alpha and beta. You might store all the data files for alpha inside data_alpha, and all the data files for beta inside data_beta. - -In your alpha configuration file, specify the data source like this: - -``` -data_source: data_alpha -``` - -Then create a folder called \_data_alpha. - -For your beta configuration file, specify the data source like this: - -``` -data_source: data_beta -``` - -Then create a folder called \_data_beta. - - -## Conditions versus includes - -If you have a lot of conditions in your text, it can get confusing. As a best practice, whenever you insert an `if` condition, add the `endif` at the same time. This will reduce the chances of forgetting to close the if statement. Jekyll won't build if there are problems with the liquid logic. - -If your text is getting busy with a lot of conditional statements, consider putting a lot of content into includes so that you can more easily see where the conditions begin and end. - -{% include links.html %} diff --git a/pages/mydoc/mydoc_content_reuse.md b/pages/mydoc/mydoc_content_reuse.md deleted file mode 100644 index dbecd1991..000000000 --- a/pages/mydoc/mydoc_content_reuse.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Content reuse -tags: [single_sourcing] -keywords: includes, conref, dita, transclusion, transclude, inclusion, reference -last_updated: July 3, 2016 -summary: "You can reuse chunks of content by storing these files in the includes folder. You then choose to include the file where you need it. This works similar to conref in DITA, except that you can include the file in any content type." -sidebar: mydoc_sidebar -permalink: mydoc_content_reuse.html -folder: mydoc ---- - -## About content reuse -You can embed content from one file inside another using includes. Put the file containing content you want to reuse (e.g., mypage.html) inside the \_includes/custom folder and then use a tag like this: - -{% raw %} -``` -{% include custom/mypage.html %} -``` -{% endraw %} - -With content in your \_includes folder, you don't add any frontmatter to these pages because they will be included on other pages already containing frontmatter. - -Also, when you include a file, all of the file's contents get included. You can't specify that you only want a specific part of the file included. However, you can use parameters with includes. - -{% unless site.output == "pdf" %} -See the following Jekyll cast for more info about using parameters with includes: - - -{% endunless %} - -## Page-level variables - -You can also create custom variables in your frontmatter like this: - -{% raw %} -```yaml ---- -title: Page-level variables -permalink: page_level_variables/ -thing1: Joe -thing2: Dave ---- -``` -{% endraw %} - -You can then access the values in those custom variables using the `page` namespace, like this: - -{% raw %} -``` -thing1: {{page.thing1}} -thing2: {{page.thing2}} -``` -{% endraw %} - - -I use includes all the time. Most of the includes in the \_includes directory are pulled into the theme layouts. For those includes that change, I put them inside custom and then inside a specific project folder. - -{% include links.html %} diff --git a/pages/mydoc/mydoc_contentcreators.md b/pages/mydoc/mydoc_contentcreators.md new file mode 100644 index 000000000..130953943 --- /dev/null +++ b/pages/mydoc/mydoc_contentcreators.md @@ -0,0 +1,55 @@ +--- +title: Content Creators Corner +keywords: content creator, twitch, youtube, personal website related to goldfarm +last_updated: June 18, 2019 +tags: [getting_started] +summary: "Page to answer FAQ for Content Creators to get their work represented here" +sidebar: mydoc_sidebar +permalink: mydoc_contentcreators.html +folder: mydoc +--- + +{% include tip.html content="If you are a Gold Farm content creator and want to have your tangible Gold Farm content information on this website, reach out to me through the various social media links above or the feedback tab which will go to my business email checked weekly."%} + +## What type of gold farm information from Content Creators are you looking for?? +Relevant gold farming information you'd like publicized consisting of: + +``` +1. Warcraft Gold making Shuffles including Vendor or Professions. +2. Shadowlands and Old World Group/Multibox Gold farms. +3. World Pet Farms. +4. BOE Mount Farms. +5. Herb and/or Mining Routes. +6. Completed TSM4 4.10 Groups (with or without Operations, up to you!). +7. Goldmaking helpful website and tools. +``` + +The way your information will be presented will follow the template in the completed guides on this site which can be located [here](https://gunnydelight.github.io/mozzletoff-wow-goldfarm-site/example.html) + +## What is the Twitch requirements to get listed on this website?? +* Twitch Affiliate+ or Partner. This baseline shows a commit to being a serious Content Creator and not a temporary fleeting decision. +* Still currently streaming or posting Gold Farm content _(does **NOT** need to be dedicated)_. +* Breaks are Okay _(AND HEALTHY)_, 6 month+ of no Content will likely result in a delisting from Twitch. Just make sure if/when you decide you come back to contact me on any of the socials above to be added back in. + +## What is the YouTube requirements to get listed on this website?? +* 300+ Subscribers +* 20+ Videos +* Covering Goldfarm or gold making relevant content! +* No expire to remove URL's from YouTube Content Creators like Twitch requirement above. As as long as the information covered in the VODs stay relevant to current WOW content, you'll stay there as a libary source of video's that people may use. + +## Mozzle, why haven't you already show cased my work?! +It is impossible _(so I'm finding out)_ to keep in constant **"know"** of who is working on Gold Farm content. Just reach out to me and ask! + +I'd like to think I'm approachable. I'm ensuring there is no "gate keeping" when it comes to Gold Farming content and remaining Switzerland. Thus the point of this page to level set expectation. + +## Can more than one Content Creator be featured on a shuffle? +Yes, I would need an Google Sheet _(or alternative spreadsheet online hosted)_ to host. I would then add your social media's to the bottom of that content page + +## I'm a Gold Farming Content Creator on Twitch & Youtube, Why havent you added me yet?? +It is impossible _(so I'm finding out)_ to keep in constant **"know"** of who is working on Gold Farm content. Just reach out to me and ask. No gate keeping, just meet the requirements mentioned above. + +## Feedback +Along the top nav right is your way to contact me by clicking on **Feedback**. + +You can also get in contact with me through my various [Social Medias](https://t.co/SRrJa1X9B7?amp=1). Thank YOU for taking the time to read through this and getting to know me a little bit more personally. + diff --git a/pages/mydoc/mydoc_excluding_files.md b/pages/mydoc/mydoc_excluding_files.md deleted file mode 100644 index 7ca77d32b..000000000 --- a/pages/mydoc/mydoc_excluding_files.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: Excluding files -tags: [single_sourcing] -last_updated: July 3, 2016 -keywords: exclusion, separating outputs, removing files from outputs -summary: "By default, all the files in your Jekyll project are included in the output (this differs from DITA projects, which don't include files unless noted on the map). If you're single sourcing, you'll need to exclude the files that shouldn't be included in the output. The sidebar doesn't control inclusion or exclusion." -sidebar: mydoc_sidebar -permalink: mydoc_exluding_files.html -folder: mydoc ---- - - -## About exclusion -By default, all files in your project are included in your output (regardless of whether they're listed in the sidebar_doc.yml file or not). To exclude files, note them in the `exclude` section in the configuration file. Here's a sample: - -``` - -exclude: - - mydoc_writers_* - - bower_components - - Gemfile -``` - -If you have different outputs for your site, you'll want to customize the exclude sections in your various configuration files. - -## Exclude strategies -Here's the process I recommend. Put all files in the root directory of your project. Suppose one project's name is alpha and the other is beta. Then name each file as follows: - -* alpha_sample.html -* beta_sample.html - -In your exclude list for your beta project, specify it as follows: - -``` -exclude: -- alpha_* -``` - -In your exclude list for your alpha project, specify it as follows: - -``` -exclude: -- beta_* -``` - -If you have more sophisticated exclusion, add another level to your file names. For example, if you have different programming languages you want to filter by, add this: - -* alpha_java_sample.html -* alpha_cpp_sample.html - -Then you exclude files for your Alpha C++ project as follows: - -``` -exclude: - -- alpha_java_* -- beta_* -``` - -And you exclude files for your Alpha Java project as follows: - -``` -exclude: - -- alpha_cpp_* -- alpha_beta_* -``` - -When you exclude folders, include the trailing slash at the end of the folder name: - -``` -exclude: -- images/alpha/ -``` - -There isn't a way to automatically exclude anything. By default, everything is included unless you explicitly list it under the exclude section. - -## Excluding draft content - -If you're working on a draft, put it inside the \_drafts folder or add `published: false` in the frontmatter. The \_drafts folder is excluded by default, so you don't have to specify it in your exclude list. - -## Limitations - -What if a file should appear in two projects but not the third? This can get tricky. For some files, rather than using a wildcard, you may need to manually specify the entire filename that you're excluding instead of excluding it by way of a wildcard pattern. - -{% include links.html %} diff --git a/pages/mydoc/mydoc_faq.md b/pages/mydoc/mydoc_faq.md deleted file mode 100644 index 6877b11da..000000000 --- a/pages/mydoc/mydoc_faq.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -title: FAQ layout -permalink: mydoc_faq_layout.html -sidebar: mydoc_sidebar -tags: [special_layouts] -keywords: frequently asked questions, FAQ, question and answer, collapsible sections, expand, collapse -last_updated: November 30, 2015 -summary: "You can use an accordion-layout that takes advantage of Bootstrap styling. This is useful for an FAQ page." -toc: false -folder: mydoc ---- - -

If you want to use an FAQ format, use the syntax shown on the faq.html page. Rather than including code samples here (which are bulky with a lot of nested div tags), just look at the source in the mydoc_faq.html theme file.

- -
-
- -
-
- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. -
-
-
- -
- -
-
- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. -
-
-
- -
- -
-
- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. -
-
-
- -
- -
-
- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. -
-
-
- -
- -
-
- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. -
-
-
- -
- -
-
- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. -
-
-
- -
- -
-
- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. -
-
-
- -
- -
-
- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. -
-
-
- -
- -
-
- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. -
-
-
- -
- - -{% include links.html %} diff --git a/pages/mydoc/mydoc_generating_pdfs.md b/pages/mydoc/mydoc_generating_pdfs.md deleted file mode 100644 index f908c3786..000000000 --- a/pages/mydoc/mydoc_generating_pdfs.md +++ /dev/null @@ -1,429 +0,0 @@ ---- -title: Generating PDFs -permalink: mydoc_generating_pdfs.html -tags: [publishing, single_sourcing, content_types] -keywords: PDF, prince, prince XML, ant, xsl fo -last_updated: July 3, 2016 -summary: "You can generate a PDF from your Jekyll project. You do this by creating a web version of your project that is printer friendly. You then use utility called Prince to iterate through the pages and create a PDF from them. It works quite well and gives you complete control to customize the PDF output through CSS, including page directives and dynamic tags from Prince." -sidebar: mydoc_sidebar -folder: mydoc ---- - - -## PDF overview -This process for creating a PDF relies on Prince XML to transform the HTML content into PDF. Prince costs about $500 per license. That might seem like a lot, but if you're creating a PDF, you're probably working for a company that sells a product, so you likely have access to some resources. There's also a free license that prints a small "P" watermark on your title page, so if you're fine with that, great. - -The basic approach is to generate a list of all web pages that need to be added to the PDF, and then add leverage Prince to package them up into a PDF. Once you set it up, building a pdf is just a matter of running a couple of commands. Also, creating a PDF this way gives you a lot more control and customization capabilities than with other methods for creating PDFs. If you know CSS, you can entirely customize the output. - -## Demo - -You can see an example of the finished product here: - - - -To generate the PDF, browse to the theme's directory in your terminal and run this script: - -```bash -. pdf-mydoc.sh -``` - -This builds a PDF for the documentation in the theme. Look in the **pdf** folder for the output, and see the "last generated date" to confirm that you generated the PDF. - -To build a PDF for the other sample projects, run these commands: - -```bash -. pdf-product1.sh -``` - -or - -```bash -. pdf-product2.sh -``` - -You can see the details of the script in these files in the theme's root directory. For example, open pdf-mydoc.sh. It contains the following: - -```bash -# Note that .sh scripts work only on Mac. If you're on Windows, install Git Bash and use that as your client. - -echo 'Kill all Jekyll instances' -kill -9 $(ps aux | grep '[j]ekyll' | awk '{print $2}') -clear - -echo "Building PDF-friendly HTML site for Mydoc ..."; -bundle exec jekyll serve --detach --config _config.yml,pdfconfigs/config_mydoc_pdf.yml; -echo "done"; - -echo "Building the PDF ..."; -prince --javascript --input-list=_site/pdfconfigs/prince-list.txt -o pdf/mydoc.pdf; - -echo "Done. Look in the pdf directory to see if it printed successfully." -``` - -After stopping all Jekyll instances, we build Jekyll using a special configuration file that specifies a unique stylesheet. The build contains a file (prince-list.txt) that contains a list of all pages to be included in the PDF. We feed this list into a Prince command to build the PDF. - -The following sections explain more about the setup. - -## 1. Set up Prince - -Download and install [Prince](http://www.princexml.com/doc/installing/). - -You can install a fully functional trial version. The only difference is that the title page will have a small Prince PDF watermark. - -## 2. Create a new configuration file for each of your PDF targets - -The PDF configuration file will build on the settings in the regular configuration file but will some additional fields. Here's the configuration file for the mydoc product within this theme. This configuration file is located in the pdfconfigs folder. - -```yaml -destination: _site/ -url: "http://127.0.0.1:4010" -baseurl: "/mydoc-pdf" -port: 4010 -output: pdf -product: mydoc -print_title: Jekyll theme for documentation — mydoc product -print_subtitle: version 5.0 -output: pdf -defaults: - - - scope: - path: "" - type: "pages" - values: - layout: "page_print" - comments: true - search: true - -pdf_sidebar: mydoc_sidebar -``` - -{% include note.html content="Although you're creating a PDF, you must still build an HTML web target before running Prince. Prince will pull from the HTML files and from the file-list for the TOC." %} - -Note that the default page layout specified by this configuration file is `page_print`. This layout strips out all the sections that shouldn't appear in the print PDF, such as the sidebar and top navigation bar. - -Also note that there's a `output: pdf` property in case you want to make some of your content unique to PDF output. For example, you could add conditional logic that checks whether `site.output` is `pdf` or `web`. If it's `pdf`, then include information only for the PDF, and so on. If you're using nav tabs, you'll definitely want to create an alternative experience in the PDF. - -In the configuration file, customize the values for the `print_title` and `print_subtitle` that you want. These will appear on the title page of the PDF. - -We will access this configure file in the PDF generation script. - -## 3. Make sure your sidebar data file has titlepage.html and tocpage.html entries - -There are two template pages in the root directory that are critical to the PDF: - -* titlepage.html -* tocpage.html - -These pages should appear in your sidebar YML file (in this product, mydoc_sidebar.yml): - -```yaml -- title: - output: pdf - type: frontmatter - folderitems: - - title: - url: /titlepage.html - output: pdf - type: frontmatter - - title: - url: /tocpage.html - output: pdf - type: frontmatter -``` - -Leave these pages here in your sidebar. (The `output: pdf` property means they won't appear in your online TOC because the conditional logic of the sidebar.html checks whether `web` is equal to `pdf` or not before including the item in the web version of the content.) - -The code in the tocpage.html is mostly identical to that of the sidebar.html page. This is essential for Prince to create the page numbers correctly with cross references. - -There's another file (in the root directory of the theme) that is critical to the PDF generation process: prince-list.txt. This file simply iterates through the items in your sidebar and creates a list of links. Prince will consume the list of links from prince-list.txt and create a running PDF that contains all of the pages listed, with appropriate cross references and styling for them all. - -{% include note.html content="If you have any files that you do not want to appear in the PDF, add output: web (rather than output: pdf) in the list of attributes in your sidebar. The prince-list.txt file that loops through the mydoc_sidebar.yml file to grab the URLs of each page that should appear in the PDF will skip over any items that do not list output: pdf in the item attributes. For example, you might not want your tag archives to appear in the PDF, but you probably will want to list them in the online help navigation." %} - -## 4. Customize your headers and footers - -Open up the css/printstyles.css file and customize what you want for the headers and footers. At the very least, customize the email address (`youremail@domain.com`) that appears in the bottom left. - -Exactly how the print styling works here is pretty nifty. You don't need to understand the rest of the content in this section unless you want to customize your PDFs to look different from what I've configured. But I'm adding this information here in case you want to understand how to customize the look and feel of the PDF output. - -This style creates a page reference for a link: - -{% raw %} -```css -a[href]::after { - content: " (page " target-counter(attr(href), page) ")" -} -``` - -You don't want cross references for any link that doesn't reference another page, so this style specifies that the content after should be blank: - -```css -a[href*="mailto"]::after, a[data-toggle="tooltip"]::after, a[href].noCrossRef::after { - content: ""; -} -``` -{% endraw %} - -{% include tip.html content="If you have a link to a file download, or some other link that shouldn't have a cross reference (such as link used in JavaScript for navtabs or collapsible sections, for example, add `noCrossRef` as a class to the link to avoid having it say \"page 0\" in the cross reference." %} - -This style specifies that after links to web resources, the URL should be inserted instead of the page number: - -```css -a[href^="http:"]::after, a[href^="https:"]::after { - content: " (" attr(href) ")"; -} -``` - -This style sets the page margins: - -```css -@page { - margin: 60pt 90pt 60pt 90pt; - font-family: sans-serif; - font-style:none; - color: gray; - -} -``` - -To set a specific style property for a particular page, you have to name the page. This allows Prince to identify the page. - -First you add frontmatter to the page that specifies the type. For the titlepage.html, here's the frontmatter: - -```yaml ---- -type: title ---- -``` - -For the tocpage, here's the frontmatter: - -```yaml ---- -type: frontmatter ---- -``` - -For the index.html page, we have this type tag (among others): - -```yaml ---- -type: first_page ---- -``` - -The default_print.html layout will change the class of the `body` element based on the type value in the page's frontmatter: - -{% raw %} -```liquid - -``` -{% endraw %} - -Now in the css/printstyles.css file, you can assign a page name based on a specific class: - -```css -body.title { page: title } -``` - -This means that for content inside of `body class="title"`, we can style this page in our stylesheet using `@page title`. - -Here's how that title page is styled: - -```css -@page title { - @top-left { - content: " "; - } - @top-right { - content: " " - } - @bottom-right { - content: " "; - } - @bottom-left { - content: " "; - } -} -``` - -As you can see, we don't have any header or footer content, because it's the title page. - -For the tocpage.html, which has the `type: frontmatter`, this is specified in the stylesheet: - -```css -body.frontmatter { page: frontmatter } -body.frontmatter {counter-reset: page 1} - - -@page frontmatter { - @top-left { - content: prince-script(guideName); - } - @top-right { - content: prince-script(datestamp); - } - @bottom-right { - content: counter(page, lower-roman); - } - @bottom-left { - content: "youremail@domain.com"; } -} -``` - -With `counter(page, lower-roman)`, we reset the page count to 1 so that the title page doesn't start the count. Then we also add some header and footer info. The page numbers start counting in lower-roman numerals. - -Finally, for the first page (which doesn't have a specific name), we restart the counting to 1 again and this time use regular numbers. - -```css -body.first_page {counter-reset: page 1} - -h1 { string-set: doctitle content() } - -@page { - @top-left { - content: string(doctitle); - font-size: 11px; - font-style: italic; - } - @top-right { - content: prince-script(datestamp); - font-size: 11px; - } - - @bottom-right { - content: "Page " counter(page); - font-size: 11px; - } - @bottom-left { - content: prince-script(guideName); - font-size: 11px; - } -} -``` - -You'll see some other items in there such as `prince-script`. This means we're using JavaScript to run some functions to dynamically generate that content. These JavaScript functions are located in the \_includes/head_print.html: - -```js - - - -``` - -There are a couple of Prince functions that are default functions from Prince. This gets the heading title of the page: - -```js - content: string(doctitle); -``` - -This gets the current page: - -```js - content: "Page " counter(page); -``` - -Because the theme uses JavaScript in the CSS, you have to add the `--javascript` tag in the Prince command (detailed later on this page). - -## 5. Customize and run the PDF script - -Duplicate the pdf-mydoc.sh file in the root directory and customize it for your specific configuration files. - -``` -echo 'Killing all Jekyll instances' -kill -9 $(ps aux | grep '[j]ekyll' | awk '{print $2}') -clear - -echo "Building PDF-friendly HTML site for Mydoc ..."; -jekyll serve --detach --config _config.yml,pdfconfigs/config_mydoc_pdf.yml; -echo "done"; - -echo "Building the PDF ..."; -prince --javascript --input-list=_site/pdfconfigs/prince-list.txt -o pdf/mydoc.pdf; -echo "done"; -``` - -Note that the first part kills all Jekyll instances. This way you won't try to serve Jekyll at a port that is already occupied. - -The `jekyll serve` command serves up the HTML-friendly PDF configurations for our two projects. This web version is where Prince will go to get its content. - -The prince script issues a command to the Prince utility. JavaScript is enabled (`--javascript`), and we tell it exactly where to find the list of files (`--input-list`) — just point to the prince-list.txt file. Then we tell it where and what to output (`-o`). - -Make sure that the path to the prince-list.txt is correct. For the output directory, I like to output the PDF file into my project's source (into the files folder). Then when I build the web output, the PDF is included and something I can refer to. - -{% include note.html content="You might not want to include the PDF in your project files, since you're likely committing the PDF to Github and as a result saving the changes from one PDF version to another with each save." %} - -## 6. Add conditions for your new builds in the PDF config file - -In the PDF configuration file, there's a section that looks like this: - -``` -{% raw %}{% if site.product == "mydoc" %} -pdf_sidebar: product2_sidebar -{% endif %} -``` - -Point to the sidebar you want here. - -What this does is allow the prince-list.txt and toc.html files to iterate through the right sidebar. Otherwise, you would need to create a unique prince-list.txt and toc.html file for each separate PDF output you have. - -## 7. Add a download button for the PDF - -You can add a download button for your PDF using some Bootstrap button code: - -```html - -``` - -Here's what that looks like: - - - -## JavaScript conflicts - -If you have JavaScript on any of your pages, Prince will note errors in Terminal like this: - -``` -error: TypeError: value is not an object -``` - -However, the PDF will still build. - -You need to conditionalize out any JavaScript from your PDF web output before building your PDFs. Make sure that the PDF configuration files have the `output: pdf` property. - -Then surround the JavaScript with conditional tags like this: - -``` -{% raw %}{% unless site.output == "pdf" %} -javascript content here ... -{% endunless %}{% endraw %} -``` - -For more detail about using `unless` in conditional logic, see [Conditional logic][mydoc_conditional_logic]. What this code means is "run this code unless this value is the case." - -## Overriding Bootstrap Print Styles - -The theme relies on Bootstrap's CSS for styling. However, for print media, Bootstrap applies the following style: - -``` -@media print{*,:after,:before{color:#000!important;text-shadow:none!important;background:0 0!important;-webkit-box-shadow:none!important;box-shadow:none!important} -``` -This is minified, but basically the `*` (asterisk) means select all, and applied the color #000 (black). As a result, the Bootstrap style strips out all color from the PDF (for Bootstrap elements). - -This is problematic for code snippets that have syntax highlighting. I decided to remove this de-coloring from the print output. I commented out the Bootstrap style: - -``` -@media print{*,:after,:before{/*color:#000!important;*/text-shadow:none!important;/*background:0 0!important*/;-webkit-box-shadow:none!important;box-shadow:none!important} -``` - -If you update Bootrap, make sure you make this edit. (Sorry, admittedly I couldn't figure out how to simply overwrite the `*` selector with a later style.) - -I did, however, remove the color from the alerts and lighten the background shading for `pre` elements. The printstyles.css has this setting. - -{% include links.html %} diff --git a/pages/mydoc/mydoc_git_collaboration.md b/pages/mydoc/mydoc_git_collaboration.md deleted file mode 100644 index ae0e511b4..000000000 --- a/pages/mydoc/mydoc_git_collaboration.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -title: Git notes and tips -summary: "If you're interacting with your team using Git, the notes and tips will help you collaborate efficiently." -tags: collaboration -keywords: git, github, collaboration, interaction, file sharing, push -published: false -sidebar: mydoc_sidebar -permalink: mydoc_git_collaboration.html -folder: mydoc ---- - - -hg fetch does a pull and update at the same time -you're prompted about any conflicts -you fix them. then you do this: - - -hg pull -u (i think this is pull and then update) - -$ hg [COMMAND] [ARGUMENTS] - -hg init -hg add -hg log -hg diff -hg revert -hg remove -hg update -You have seen that it is possible to switch revision using hg update. -clone - -commit - -The first feature of the diff command is to show the differences between the last revision of a file (the state at the last commit command) and the current version. It can also show the differences between any two specified revisions. For example, on apache2.conf, the diff command can be used as follows: -$ hg diff -r 1 -r 2 apache2.conf - -To print each line of a file with the revision at which the line was created (and with the --user option, we come to know who committed this revision), type: -$ hg annotate [FILE] or $ hg blame [FILE] - -To search for a pattern in version controlled files, use hg grep; it will search this pattern in every version of the file and it will print the first one in which it appears, such as hg annotate. For example: -$ hg grep new apache2.conf - -You can also print the content of a file at a given revision even without changing the current working directory using hg cat -r REVISION. - -Whenever changes have been committed but not yet pushed, the outgoing command lists all the changesets that are present in the current repository but not yet found in the destination (the ones that are candidates to be pushed), whereas the incoming command shows you the changesets that are found in the source repository but have not been pulled yet. So here, if you use the outgoing command, you will see - -push -pull -fetch -merge -resolve --mark - -As you can see, you have added John's change to your repository because hg log is listing it. But it is not yet present in your working copy; you need to update the working directory to the tip revision, which is the default of the update command, when no revision is passed as argument: - -You can now see John's change in the working directory. If some files had been modified, either committed or not, the modifications would have been seamlessly merged with that of John's. If there was a conflict, Mercurial would have told us. - -hg pull --update or -u: This option combines both the pull and the update commands, not only pulling new changesets into the local repository, but also updating the working directory to the head of these new changes. - -| annotate, blame | show changeset information by line for each file | -| diff | diff repository (or selected files) | -| forget {filename} | forget the specified files on the next commit | - - -hg fetch. This extension acts as a combination of hg pull -u, hg merge and hg commit. It begins by pulling changes from another repository into the current repository. If it finds that the changes added a new head to the repository, it updates to the new head, begins a merge, then (if the merge succeeded) commits the result of the merge with an automatically-generated commit message. If no new heads were added, it updates the working directory to the new tip changeset. - - - -i like - -hg fetch does a pull and update at the same time -you're prompted about any conflicts -you fix them. then you do this: hg resolve --mark - - -hg pull -u (i think this is pull and then update) - -$ hg [COMMAND] [ARGUMENTS] - -hg init -hg add -hg log -hg diff -hg revert -hg remove -hg update -You have seen that it is possible to switch revision using hg update. -clone -addremove, which allows you to automatically add all new files and remove (from version control) files that have been deleted. -log -commit - -The first feature of the diff command is to show the differences between the last revision of a file (the state at the last commit command) and the current version. It can also show the differences between any two specified revisions. For example, on apache2.conf, the diff command can be used as follows: -$ hg diff -r 1 -r 2 apache2.conf - -To print each line of a file with the revision at which the line was created (and with the --user option, we come to know who committed this revision), type: -$ hg annotate [FILE] or $ hg blame [FILE] - -To search for a pattern in version controlled files, use hg grep; it will search this pattern in every version of the file and it will print the first one in which it appears, such as hg annotate. For example: -$ hg grep new apache2.conf - -You can also print the content of a file at a given revision even without changing the current working directory using hg cat -r REVISION. - -Whenever changes have been committed but not yet pushed, the outgoing command lists all the changesets that are present in the current repository but not yet found in the destination (the ones that are candidates to be pushed), whereas the incoming command shows you the changesets that are found in the source repository but have not been pulled yet. So here, if you use the outgoing command, you will see - -push -pull -fetch -merge -resolve --mark - -As you can see, you have added John's change to your repository because hg log is listing it. But it is not yet present in your working copy; you need to update the working directory to the tip revision, which is the default of the update command, when no revision is passed as argument: - -You can now see John's change in the working directory. If some files had been modified, either committed or not, the modifications would have been seamlessly merged with that of John's. If there was a conflict, Mercurial would have told us. - -hg pull --update or -u: This option combines both the pull and the update commands, not only pulling new changesets into the local repository, but also updating the working directory to the head of these new changes. - -Bookmarks are tags that move forward automatically to subsequent changes, leaving no mark on the changesets that previously had that bookmark pointing toward them. Named branches, on the other hand, are indelible marks that are part of a changeset. Multiple heads can be on the same branch, but only one head at a time can be pointed to by the same bookmark. Named branches are pushed/pulled from repo to repo, and bookmarks don't travel. - -The default branch name in Mercurial is “default”. - -The slowest, safest way to create a branch with Mercurial is to make a new clone of the repository. this is really fascinating -- a clone is merely a branch. - -Discarding a branch you don’t want any more is very easy with cloned branches. It’s as simple as rm -rf test-project-feature-branch. There’s no need to mess around with editing repository history, you just delete the damn thing. - -The next way to branch is to use a bookmark. For example: - -$ cd ~/src/test-project -$ hg bookmark main -$ hg bookmark feature -Now you’ve got two bookmarks (essentially a tag) for your two branches at the current changeset. - -To switch to one of these branches you can use hg update feature to update to the tip changeset of that branch and mark yourself as working on that branch. When you commit, it will move the bookmark to the newly created changeset. - - -## Git -HEAD is a reference to the last commit in the current checked out branch. - -This is a good tutorial: https://www.digitalocean.com/community/tutorials/how-to-use-git-branches. - - -## Branching - -| Commands | Description | -|------|-------| -| List all branches | `git branch a` (the * indicates the branch you're on) | -| Create new branch | `git -b branchname` or `git branch branchname` | -| Checkout a branch | `git checkout branchname` | -| Create new branch and checkout at the same time| `git checkout -b branchname` | -| Merge into current branch | First go into the branch you want to merge changes into. Then do `git merge branchname`. For example, to merge branch b into branch master, first checkout branch master: `git checkout a`. Now merge b into master: `git merge b`.| - -git lg - -git checkout master -git merge search | git merge --no-ff search - -the latter (--no-ff) keeps the additional information that these commits were made on a branch. -then type a commit message (:wq) -git branch -d search - -git add . (works same as add --all) -git commit am "my commit message" (this performs both adding and commit message at same time) - -with merge conflicts: - -git status (shows you all the files that can't be added due to merge conflicts) -fix the conflicts -then git add . (tells git you fixed the conflicts) -then git status -git commit - -From the interface, you can also create a pull request to merge all of the changes from a specific branch into another branch. - - - -## General commands - -| Commands | Description | -|------|-------| -| start tracking files | `git add` | -| see what has changed since last commit | `git diff` | -| commit changes | `git commit` | -| | | - - -{% include links.html %} diff --git a/pages/mydoc/mydoc_glossary.md b/pages/mydoc/mydoc_glossary.md deleted file mode 100644 index 264fed782..000000000 --- a/pages/mydoc/mydoc_glossary.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: Glossary layout -tags: [formatting, special_layouts] -keywords: definitions, glossaries, terms, style guide -last_updated: July 3, 2016 -summary: "Your glossary page can take advantage of definitions stored in a data file. This gives you the ability to reuse the same definition in multiple places. Additionally, you can use Bootstrap classes to arrange your definition list horizontally." -sidebar: mydoc_sidebar -permalink: mydoc_glossary.html -toc: false -folder: mydoc ---- - - -You can create a glossary for your content. First create your glossary items in a data file such as glossary.yml. - -Then create a page and use definition list formatting, like this: - -fractious -: {{site.data.glossary.fractious}} - -gratuitous -: {{site.data.glossary.gratuitous}} - -haughty -: {{site.data.glossary.haughty}} - -gratuitous -: {{site.data.glossary.gratuitous}} - -impertinent -: {{site.data.glossary.intrepid}} - -Here's the code: - -``` -{% raw %}fractious -: {{site.data.glossary.fractious}} - -gratuitous -: {{site.data.glossary.gratuitous}} - -haughty -: {{site.data.glossary.haughty}} - -gratuitous -: {{site.data.glossary.gratuitous}} - -impertinent -: {{site.data.glossary.intrepid}}{% endraw %} -``` - -The glossary works well as a link in the top navigation bar. - -## Horizontally styled definiton lists - -You can also change the definition list (`dl`) class to `dl-horizontal`. This is a Bootstrap specific class. If you do, the styling looks like this: - -
- -
fractious
-
{{site.data.glossary.fractious}}
- -
gratuitous
-
{{site.data.glossary.gratuitous}}
- -
haughty
-
{{site.data.glossary.haughty}}
- -
gratuitous
-
{{site.data.glossary.gratuitous}}
- -
impertinent
-
{{site.data.glossary.impertinent}}
- -
intrepid
-
{{site.data.glossary.intrepid}}
- -
- -For this type of list, you must use HTML. The list would then look like this: - -```html -{% raw %}
- -
fractious
-
{{site.data.glossary.fractious}}
- -
gratuitous
-
{{site.data.glossary.gratuitous}}
- -
haughty
-
{{site.data.glossary.haughty}}
- -
gratuitous
-
{{site.data.glossary.gratuitous}}
- -
impertinent
-
{{site.data.glossary.impertinent}}
- -
intrepid
-
{{site.data.glossary.intrepid}}
- -
{% endraw %} -``` - -If you squish your screen small enough, at a certain breakpoint this style reverts to the regular `dl` class. - -Although I like the side-by-side view for shorter definitions, I found it problematic with longer definitions. - - -{% include links.html %} diff --git a/pages/mydoc/mydoc_help_api.md b/pages/mydoc/mydoc_help_api.md deleted file mode 100644 index a32c2dbb9..000000000 --- a/pages/mydoc/mydoc_help_api.md +++ /dev/null @@ -1,363 +0,0 @@ ---- -title: Help APIs and UI tooltips -tags: [publishing, single_sourcing, content_types] -last_updated: July 3, 2016 -keywords: API, content API, UI text, inline help, context-sensitive help, popovers, tooltips -summary: "You can loop through files and generate a JSON file that developers can consume like a help API. Developers can pull in values from the JSON into interface elements, styling them as popovers for user interface text, for example. The beauty of this method is that the UI text remains in the help system (or at least in a single JSON file delivered to the dev team) and isn't hard-coded into the UI." -sidebar: mydoc_sidebar -permalink: mydoc_help_api.html -folder: mydoc ---- - -## Full code demo of content API - -You can create a help API that developers can use to pull in content. - -For the full code demo, see the notes in the [Tooltips file](tooltips.html). - -In this demo, the popovers pull in and display content from the information in a tooltips.json file located in the same directory. - -Instead of placing the JSON source in the same directory, you could also host the JSON file on another site. - -Additionally, instead of tooltip popovers, you could also print content directly to the page. Basically, whatever you can stuff into a JSON file, developers can integrate it onto a page. - -## Diagram overview - -Here's a diagram showing the basic idea of the help API: - - - -Is this really an API? Well, sort of. The help content is pushed out into a JSON file that other websites and applications can easily consume. The endpoints don't deliver different data based on parameters added to a URL. But the overall concept is similar to an API: you have a client requesting resources from a server. - -Note that in this scenario, the help is openly accessible on the web. If you have a private system, it's more complicated. - -To deliver help this way using Jekyll, follow the steps in each of the sections below. - -## 1. Create a "collection" for the help content - -A collection is another content type that extends Jekyll beyond the use of pages and posts. Call the collection "tooltips." - -Add the following information to your configuration file to declare your collection: - -``` -collections: - tooltips: - output: false -``` - -In your Jekyll project's root directory, create a new folder called "_tooltips" and put every page that you want to be part of that tooltips collection inside that folder. - -In Jekyll, folders that begin with an underscore ("_") aren't included in the output. However, in the collection information that you add to your configuration file, if you change `output` to `true`, the tooltips folder will appear in the output, and each page inside tooltips will be generated. You most likely don't want this for tooltips (you just want the JSON file), so make the `output` setting `false`. - -## 2. Create tooltip definitions in a YAML file - -Inside the \_data folder, create a YAML file called something like definitions.yml. Add the definitions for each of your tooltips here like this: - -```yaml -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." -``` - -The definition of basketball is stored this data file so that you can re-use it in other parts of the help as well. You'll likely want the definition to appear not only in the tooltip in the UI, but also in the regular documentation as well. - -## 3. Create pages in your collection - -Create pages inside your new tooltips collection (that is, inside the \_tooltips folder). Each page needs to have a unique `id` in the frontmatter as well as a `product`. Then reference the definition you created in the definitions.yml file. - -Here's an example: - -```yaml -{% raw %} ---- -doc_id: basketball -product: mydoc ---- - -{{site.data.definitions.basketball}}{% endraw %} -``` - -(Note: Avoid using `id`, as it seems to generate out as `/tooltips/basketball` instead of just `basketball.) - -You need to create a separate file for each tooltip you want to deliver. - -The product attribute is required in the frontmatter to distinguish the tooltips produced here from the tooltips for other products in the same \_tooltips folder. When creating the JSON file, Jekyll will iterate through all the pages inside \_tooltips, regardless of any subfolders included here. - -## 4. Create a JSON file that loops through your collection pages - -Now it's time to create a JSON file with Liquid code that iterates through our tooltip collection and grabs the information from each tooltip file. - -Inside your project's pages directory (e.g., mydoc), add a file called "tooltips.json." (You can use whatever name you want.) Add the following to your JSON file: - -{% raw %} -```liquid ---- -layout: null -search: exclude ---- - -{ -"entries": -[ -{% for page in site.tooltips %} -{ -"doc_id": "{{ page.doc_id }}", -"body": "{{ page.content | strip_newlines | replace: '\', '\\\\' | replace: '"', '\\"' }}" -} {% unless forloop.last %},{% endunless %} -{% endfor %} -] -} - -``` -{% endraw %} - -This code will loop through all pages in the tooltips collection and insert the `id` and `body` into key-value pairs for the JSON code. Here's an example of what that looks like after it's processed by Jekyll in the site build: - -```json -{ - "entries": [ - { - "doc_id": "baseball", - "body": "{{site.data.definitions.baseball}}" - }, - { - "doc_id": "basketball", - "body": "{{site.data.definitions.basketball}}" - }, - { - "doc_id": "football", - "body": "{{site.data.definitions.football}}" - }, - { - "doc_id": "soccer", - "body": "{{site.data.definitions.soccer}}" - } - ] -} -``` - -You can also view the same JSON file here: tooltips.json. - -You can add different fields depending on how you want the JSON to be structured. Here we just have to fields: `doc_id` and `body`. And the JSON is looking just in the tooltips collection that we created. - -{% include tip.html content="Check out [Google's style guide](https://google.github.io/styleguide/jsoncstyleguide.xml) for JSON. These best practices can help you keep your JSON file valid." %} - -Note that you can create different JSON files that specialize in different content. For example, suppose you have some getting started information. You could put that into a different JSON file. Using the same structure, you might add an `if` tag that checks whether the page has frontmatter that says `type: getting_started` or something. Or you could put the content into separate collection entirely (different from tooltips). - -By chunking up your JSON files, you can provide a quicker lookup. (I'm not sure how big the JSON file can be before you experience any latency with the jQuery lookup.) - -## 5. Build your site and look for the JSON file - -When you build your site, Jekyll will iterate through every page in your _tooltips folder and put the page id and body into this format. In the output, look for the JSON file in the tooltips.json file. You'll see that Jekyll has populated it with content. This is because of the triple hyphen lines in the JSON file — this instructs Jekyll to process the file. - -## 6. Allow CORS access to your help if stored on a remote server - -You can simply deliver the JSON file to devs to add to the project. But if you have the option, it's best to keep the JSON file stored in your own help system. Assuming you have the ability to update your content on the fly, this will give you completely control over the tooltips without being tied to a specific release window. - -When people make calls to your site *from other domains*, you must allow them access to get the content. To do this, you have to enable something called CORS (cross origin resource sharing) within the server where your help resides. - -In other words, people are going to be executing calls to reach into your site and grab your content. Just like the door on your house, you have to unlock it so people can get in. Enabling CORS is unlocking it. - -How you enable CORS depends on the type of server. - -If your server setup allows htaccess files to override general server permissions, create an .htaccess file and add the following: - -``` -Header set Access-Control-Allow-Origin "*" -``` - -Store this in the same directory as your project. This is what I've done in a directory on my web host (bluehost.com). Inside http://idratherassets.com/wp-content/apidemos/, I uploaded a file called ".htaccess" with the preceding code. - -After I uploaded it, I renamed it to .htaccess, right-clicked the file and set the permissions to 774. - -To test whether your server permissions are set correctly, open a terminal and run the following curl command pointing to your tooltips.json file: - -``` -curl -I http://idratherassets.com/wp-content/apidemos/tooltips.json -``` - -The `-I` command tells cURL to return the request header only. - -If the server permissions are set correctly, you should see the following line somewhere in the response: - -```xml -Access-Control-Allow-Origin: * -``` - -If you don't see this response, CORS isn't allowed for the file. - -If you have an AWS S3 bucket, you can supposedly add a CORS configuration to the bucket permissions. Log into AWS S3 and click your bucket. On the right, in the Permissions section, click **Add CORS Configuration**. In that space, add the following policy: - -```xml - - - * - GET - - -``` - -(Although this should work, in my experiment it doesn't. And I'm not sure why...) - -In other server setups, you may need to edit one of your Apache configuration files. See [Enable CORS](http://enable-cors.org/server.html) or search online for ways to allow CORS for your server. - -If you don't have CORS enabled, users will see a CORS error/warning message in the console of the page making the request. - -{% include tip.html content="If enabling CORS is problematic, you could always just send developers the tooltips.json file and ask them to place it on their own server." %} - -## 7. Explain how developers can access the help - -Developers can access the help using the `.get` method from jQuery, among other methods. Here's an example of how to get tooltips for basketball, baseball, football, and soccer: - -```js -{% raw %}var url = "tooltips.json"; - - $.get( url, function( data ) { - - /* Bootstrap popover text is defined inside a data-content attribute inside an element. That's - why I'm using attr here. If you just want to insert content on the page, use append and remove the data-content argument from the parentheses.*/ - - $.each(data.entries, function(i, page) { - if (page.doc_id == "basketball") { - $( "#basketball" ).attr( "data-content", page.body ); - } - - if (page.doc_id == "baseball") { - $( "#baseball" ).attr( "data-content", page.body ); - } - if (page.doc_id == "football") { - $( "#football" ).attr( "data-content", page.body ); - } - - if (page.doc_id == "soccer") { - $( "#soccer" ).attr( "data-content", page.body ); - } - - - }); - });{% endraw %} -``` - -View the tooltip demo for a demonstration. See the source code for full code details. - -The `url` in the demo is relative, but you could equally point it to an absolute path on a remote host assuming CORS is enabled on the host. - -The `each` method looks through all the JSON content to find the item whose `page.id` is equal to `basketball`. It then looks for an element on the page named `#basketball` and adds a `data-content` attribute to that element. - -{% include warning.html content="Make sure your JSON file is valid. Otherwise, this method won't work. I use the [JSON Formatter extension for Chrome](https://chrome.google.com/webstore/detail/json-formatter/bcjindcccaagfpapjjmafapmmgkkhgoa?hl=en). When I go to the tooltips.json page in my browser, the JSON content — if valid — is nicely formatted (and includes some color coding). If the file isn't valid, it's not formatted and there isn't any color. You can also check the JSON formatting using [JSON Formatter and Validator](http://jsonformatter.curiousconcept.com/). If your JSON file isn't valid, identify the problem area using the validator and troubleshoot the file causing issues. It's usually due to some code that isn't escaping correctly." %} - -Why `data-content`? Well, in this case, I'm using [Bootstrap popovers](http://getbootstrap.com/javascript/#popovers) to display the tooltip content. The `data-content` attribute is how Bootstrap injects popovers. - -Here's the section on the page where the popover is inserted: - -``` -

Basketball

-``` - -Notice that I just have `id="basketball"` added to this popover element. Developers merely need to add a unique ID to each tooltip they want to pull in the help content. Either you tell developers the unique ID they should add, or ask them what IDs they added (or just tell them to use an ID that matches the field's name). - -In order to use jQuery and Bootstrap, you'll need to add the appropriate references in the head tags of your page: - -```js - - - - - -``` - -Again, see the Tooltip Demo for a demo of the full code. - -Note that even though you reference a Bootstrap JS script, Bootstrap's popovers require you to initialize them using the above code as well — they aren't turned on by default. - -View the source code of the tooltip demo for the full comments. - -## 8. Create easy links to embed the help in your help site - -You might also want to insert the same content into different parts of your help site. For example, if you have tooltips providing definitions for fields, you'll probably want to create a page in your help that lists those same definitions. - -You could use the same method developers use to pull help content into their applications. But it will probably be easier to simply use Jekyll's tags for doing it. - -Here's how you would reuse the content: - - -```html -{% raw %}

Reuse Demo

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SportComments
Basketball{{site.data.definitions.basketball}}
Baseball{{site.data.definitions.baseball}}
Football{{site.data.definitions.football}}
Soccer{{site.data.definitions.soccer}}
{% endraw %} -``` - -And here's the code: - -

Reuse Demo

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SportComments
Basketball{{site.data.definitions.basketball}}
Baseball{{site.data.definitions.baseball}}
Football{{site.data.definitions.football}}
Soccer{{site.data.definitions.soccer}}
- -Now you have both documentation and UI tooltips generated from the same definitions file. - -{% include links.html %} diff --git a/pages/mydoc/mydoc_hyperlinks.md b/pages/mydoc/mydoc_hyperlinks.md deleted file mode 100644 index 62703abfe..000000000 --- a/pages/mydoc/mydoc_hyperlinks.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Links -audience: writer, designer -tags: [formatting, navigation] -keywords: links, hyperlinks, cross references, related links, relationship tables -summary: "When creating links, you can use standard HTML or Markdown formatting. However, you can also implement an automated approach to linking that makes linking much less error-prone (meaning less chances of broken links in your output) and requiring less effort." -last_updated: July 3, 2016 -sidebar: mydoc_sidebar -permalink: mydoc_hyperlinks.html -folder: mydoc ---- - -## Create an external link - -When linking to an external site, use Markdown formatting because it's simplest: - -``` -[Google](http://google.com) -``` - -## Linking to internal pages - -When linking to internal pages, you can manually link to the pages like this: - -``` -[Icons](mydoc_icons.html) -``` - -However, if you change the file name, you'll have to update all of your links. diff --git a/pages/mydoc/mydoc_icons.md b/pages/mydoc/mydoc_icons.md deleted file mode 100644 index 791351b38..000000000 --- a/pages/mydoc/mydoc_icons.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -title: Icons -tags: [formatting] -keywords: font icons, buttons, images, vectors, font awesome, glyphicons -last_updated: July 16, 2016 -summary: "You can integrate font icons through the Font Awesome and Glyphical Halflings libraries. These libraries allow you to embed icons through their libraries delivered as a link reference. You don't need any image libraries downloaded in your project." -sidebar: mydoc_sidebar -permalink: mydoc_icons.html -folder: mydoc ---- - -## Font icon options -The theme has two font icon sets integrated: Font Awesome and Glyphicons Halflings. The latter is part of Bootstrap, while the former is independent. Font icons allow you to insert icons drawn as vectors from a CDN (so you don't have any local images on your own site). - -## External icons - -When you link to an external site, like [Jekyll](http://jekyllrb.com), an icon appears after the link. If you want to remove this icon, comment out this style in css/customstyles.css. - -```css -/* this part adds an icon after external links, using FontAwesome*/ -a[href^="http://"]:after, a[href^="https://"]:after { - content: "\f08e"; - font-family: FontAwesome; - font-weight: normal; - font-style: normal; - display: inline-block; - text-decoration: none; - padding-left: 3px; -} -``` - -## See Font Awesome icons available - -Go to the [Font Awesome library](http://fortawesome.github.io/Font-Awesome/icons/) to see the available icons. - -The Font Awesome icons allow you to adjust their size by simply adding `fa-2x`, `fa-3x` and so forth as a class to the icon to adjust their size to two times or three times the original size. As vector icons, they scale crisply at any size. - -Here's an example of how to scale up a camera icon: - -```html - normal size (1x) - fa-lg - fa-2x - fa-3x - fa-4x - fa-5x -``` - -Here's what they render to: - - 1x - fa-lg - fa-2x - fa-3x - fa-4x - fa-5x - -With Font Awesome, you always use the `i` tag with the appropriate class. You also implement `fa` as a base class first. You can use font awesome icons inside other elements. Here I'm using a Font Awesome class inside a Bootstrap alert: - -```html -