diff --git a/_config.yml b/_config.yml index ac7b003..66a26b7 100644 --- a/_config.yml +++ b/_config.yml @@ -12,7 +12,7 @@ site_title: Jekyll theme for designers # this appears in the html browser tab for the site title (seen mostly by search engines, not users) company_name: Your company # this appears in the footer -github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/reviews +github_editme_path: tomjohnson1492/documentation-theme-jekyll/blob/gh-pages # if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. disqus_shortname: idrbwjekyll # if you're using disqus for comments, add the shortname here. if not, leave this value blank. @@ -86,4 +86,3 @@ defaults: description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features." # the description is used in the feed.xml file - diff --git a/_layouts/page.html b/_layouts/page.html index 5eae7ef..e1fc11f 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -33,13 +33,12 @@ layout: default {% if site.github_editme_path %} - Edit me - {% endif %} - - {% endunless %} + Edit me {{content}} + {% endunless %} +
{% if page.tags != null %} Tags: diff --git a/index.md b/index.md index e467898..d3b5732 100644 --- a/index.md +++ b/index.md @@ -5,7 +5,7 @@ sidebar: mydoc_sidebar type: homepage --- -## Overview +## Overview 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. @@ -114,7 +114,7 @@ entries: product: Jekyll Doc Theme version: 5.0 folders: - - title: Overview + - title: Overview output: web, pdf folderitems: - title: Some page @@ -123,7 +123,7 @@ entries: - title: Another page url: /another-doc-page/ output: web, pdf - + - title: Configuration output: web folderitems: @@ -243,15 +243,15 @@ When you want to insert paragraphs, notes, code snippets, or other matter in bet ``` 1. First item - + ``` alert("hello"); ``` - + 2. Second item - + Some pig! - + 3. Third item ``` @@ -265,6 +265,3 @@ If you want to use a simple system for managing links, see the "Managed Links" s ## Other instructions For other details in working with the theme, see the various sections in the sidebar. - - - diff --git a/mydoc/mydoc_about.md b/mydoc/mydoc_about.md index 204beb5..0e7995a 100644 --- a/mydoc/mydoc_about.md +++ b/mydoc/mydoc_about.md @@ -6,6 +6,7 @@ tags: [getting_started] summary: "I have used this theme for projects that I've worked on as a professional technical writer." sidebar: mydoc_sidebar permalink: /mydoc_about/ +folder: mydoc --- My name is Tom Johnson, and I'm a technical writer, blogger, and podcaster based in San Jose, California. My blog is here: [http://idratherbewriting.com](http://idratherbewriting.com). I write several posts there a week. See [my blog's about page](http://idratherbewriting.com/aboutme/) for more details about me. diff --git a/mydoc/mydoc_about_ruby_gems_bundler.md b/mydoc/mydoc_about_ruby_gems_bundler.md index a79ccfb..66d563e 100644 --- a/mydoc/mydoc_about_ruby_gems_bundler.md +++ b/mydoc/mydoc_about_ruby_gems_bundler.md @@ -5,23 +5,24 @@ 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/ +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. +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. +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. +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. + +[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: @@ -51,17 +52,17 @@ 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 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" @@ -71,7 +72,7 @@ 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. +The gems it retrieves are listed separately on each line. Here no versions are specified. Sometimes gemfiles will specify the versions like this: @@ -86,7 +87,7 @@ 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*. +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. @@ -249,4 +250,3 @@ BUNDLED WITH 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). - diff --git a/mydoc/mydoc_adding_tooltips.md b/mydoc/mydoc_adding_tooltips.md index f6149af..05065c6 100644 --- a/mydoc/mydoc_adding_tooltips.md +++ b/mydoc/mydoc_adding_tooltips.md @@ -6,14 +6,15 @@ last_updated: March 20, 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/ +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. +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 %} +{% raw %} ```html Jekyll is my favorite tool for building websites. ``` @@ -21,4 +22,4 @@ Suppose you have a glossary.yml file inside your \_data folder. You could pull i This renders to the following: -Jekyll is my favorite tool for building websites. \ No newline at end of file +Jekyll is my favorite tool for building websites. diff --git a/mydoc/mydoc_alerts.md b/mydoc/mydoc_alerts.md index 6896116..c6c33cb 100644 --- a/mydoc/mydoc_alerts.md +++ b/mydoc/mydoc_alerts.md @@ -6,10 +6,11 @@ last_updated: March 20, 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/ +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, just reference the appropriate value stored in the alerts.yml file as described in the following sections. +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 @@ -64,11 +65,11 @@ These alerts leverage includes stored in the \_include folder. The `content` opt {% 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/) for more information. +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 mreo than one or two paragraphs, but really it's just a stylistic preference whether to use an alert or callout. +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: @@ -103,7 +104,7 @@ Here's an example of each different type of callout: {% 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). +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: @@ -115,6 +116,51 @@ 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 (\_congfig.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. diff --git a/mydoc/mydoc_build_arguments.md b/mydoc/mydoc_build_arguments.md index fecdac2..67aa1e0 100644 --- a/mydoc/mydoc_build_arguments.md +++ b/mydoc/mydoc_build_arguments.md @@ -6,6 +6,7 @@ last_updated: March 20, 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/ +folder: mydoc --- ## How to build Jekyll sites @@ -63,7 +64,3 @@ 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: ![iTerm profile settings to kill all Jekyll]({{ "/images/killalljekyll.png" | prepend: site.baseurl }}) - - - - diff --git a/mydoc/mydoc_build_scripts.md b/mydoc/mydoc_build_scripts.md index b70f19d..3444cc9 100644 --- a/mydoc/mydoc_build_scripts.md +++ b/mydoc/mydoc_build_scripts.md @@ -1,6 +1,6 @@ --- title: 10. Configure the build scripts -tags: +tags: - publishing keywords: "build scripts, generating outputs, building, publishing" last_updated: "November 30, 2016" @@ -9,11 +9,12 @@ series: "Getting Started" weight: 10 sidebar: mydoc_sidebar permalink: /mydoc_build_scripts/ +folder: mydoc --- {% include custom/getting_started_series.html %} -## About the build scripts +## 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. @@ -21,19 +22,19 @@ The mydoc project has 5 build scripts and a script that runs them all. These scr 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: +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 @@ -64,7 +65,7 @@ echo "All done serving up the PDF-friendly sites. Now let's generate the PDF fil 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. +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. @@ -95,7 +96,7 @@ This script builds the PDF output using the Prince command. The script reads the 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. +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.) @@ -142,11 +143,11 @@ echo "All done pushing doc outputs to the server" ``` -This script assumes you're publishing content onto a Linux 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. +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. @@ -189,5 +190,5 @@ After you've configured all the scripts, you can run them all by running `. mydo ## 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 %} \ No newline at end of file +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 %} diff --git a/mydoc/mydoc_collections.md b/mydoc/mydoc_collections.md index 27eb323..d0ca46c 100644 --- a/mydoc/mydoc_collections.md +++ b/mydoc/mydoc_collections.md @@ -6,6 +6,7 @@ last_updated: March 20, 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/ +folder: mydoc --- ## What are collections @@ -34,4 +35,4 @@ I haven't found a huge use for collections in normal documentation. However, I d ## Video tutorial on collections -See this [video tutorial on Jekyll.tips](http://jekyll.tips/jekyll-casts/introduction-to-collections/) for more details on collections. \ No newline at end of file +See this [video tutorial on Jekyll.tips](http://jekyll.tips/jekyll-casts/introduction-to-collections/) for more details on collections. diff --git a/mydoc/mydoc_commenting_on_files.md b/mydoc/mydoc_commenting_on_files.md index f4454d7..4746a75 100644 --- a/mydoc/mydoc_commenting_on_files.md +++ b/mydoc/mydoc_commenting_on_files.md @@ -1,17 +1,18 @@ --- title: Commenting on files -tags: +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/ +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. +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. @@ -23,10 +24,7 @@ Here's the code for that button on the page.html layout: {% if site.github_editme_path %} - Edit me - {% endif %} - - {% endunless %} + Edit me ``` {% endraw %} @@ -49,7 +47,7 @@ If you want people to collaborate on your project so that their edits get commit 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. -{{site.data.alerts.note}} 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.{{site.data.alerts.end}} +{{site.data.alerts.note}} 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.{{site.data.alerts.end}} ## Workflow @@ -58,10 +56,10 @@ Users will make edits in your "reviews" branch (or whatever you want to call it) 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. +Note that if you're making updates online, those updates will be out of sync with any local edits. {{site.data.alerts.warning}} 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.{{site.data.alerts.end}} ## 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. \ No newline at end of file + 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. diff --git a/mydoc/mydoc_conditional_logic.md b/mydoc/mydoc_conditional_logic.md index 9915594..6855517 100644 --- a/mydoc/mydoc_conditional_logic.md +++ b/mydoc/mydoc_conditional_logic.md @@ -6,22 +6,23 @@ last_updated: March 20, 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/ +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. +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. +However, you can still of course use conditional logic as needed. {{site.data.alerts.tip}} Definitely check out Liquid's documentation for more details about how to use operators and other liquid markup. The notes here are a small, somewhat superficial sample from the site.{{site.data.alerts.end}} ## 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. +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 @@ -43,7 +44,7 @@ Here's some info about Windows ... ``` {% 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. +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: @@ -65,7 +66,7 @@ You don't need the `elsif` or `else`. You could just use an `if` (but be sure to ## 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. +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`: @@ -148,7 +149,6 @@ 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 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. - diff --git a/mydoc/mydoc_content_reuse.md b/mydoc/mydoc_content_reuse.md index 2d635fe..f80a5c0 100644 --- a/mydoc/mydoc_content_reuse.md +++ b/mydoc/mydoc_content_reuse.md @@ -6,6 +6,7 @@ last_updated: March 20, 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/ +folder: mydoc --- ## About content reuse diff --git a/mydoc/mydoc_excluding_files.md b/mydoc/mydoc_excluding_files.md index 68226bf..53fb576 100644 --- a/mydoc/mydoc_excluding_files.md +++ b/mydoc/mydoc_excluding_files.md @@ -6,6 +6,7 @@ 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/ +folder: mydoc --- @@ -14,7 +15,7 @@ By default, all files in your project are included in your output (regardless of ``` -exclude: +exclude: - mydoc_writers_* - bower_components - Gemfile @@ -31,7 +32,7 @@ Here's the process I recommend. Put all files in the root directory of your proj In your exclude list for your beta project, specify it as follows: ``` -exclude: +exclude: - alpha_* ``` @@ -50,7 +51,7 @@ If you have more sophisticated exclusion, add another level to your file names. Then you exclude files for your Alpha C++ project as follows: ``` -exclude: +exclude: - alpha_java_* - beta_* @@ -76,8 +77,8 @@ There isn't a way to automatically exclude anything. By default, everything is i ## 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. +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. \ No newline at end of file +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. diff --git a/mydoc/mydoc_faq.html b/mydoc/mydoc_faq.html index 367492f..1bde9d6 100644 --- a/mydoc/mydoc_faq.html +++ b/mydoc/mydoc_faq.html @@ -7,6 +7,7 @@ keywords: frequently asked questions, FAQ, question and answer, collapsible sect 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.

@@ -131,4 +132,3 @@ toc: false
- \ No newline at end of file diff --git a/mydoc/mydoc_generating_pdfs.md b/mydoc/mydoc_generating_pdfs.md index 0c494b2..98c0a62 100644 --- a/mydoc/mydoc_generating_pdfs.md +++ b/mydoc/mydoc_generating_pdfs.md @@ -6,6 +6,7 @@ keywords: PDF, prince, prince XML, ant, xsl fo last_updated: March 20, 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 --- diff --git a/mydoc/mydoc_git_collaboration.md b/mydoc/mydoc_git_collaboration.md index 48334ed..5b42aa4 100644 --- a/mydoc/mydoc_git_collaboration.md +++ b/mydoc/mydoc_git_collaboration.md @@ -6,6 +6,7 @@ keywords: git, github, collaboration, interaction, file sharing, push published: false sidebar: mydoc_sidebar permalink: /mydoc_git_collaboration/ +folder: mydoc --- @@ -25,7 +26,7 @@ hg diff hg revert hg remove hg update -You have seen that it is possible to switch revision using hg update. +You have seen that it is possible to switch revision using hg update. clone commit @@ -39,7 +40,7 @@ $ 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. +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 @@ -64,7 +65,7 @@ hg fetch. This extension acts as a combination of hg pull -u, hg merge and hg co -i like +i like hg fetch does a pull and update at the same time you're prompted about any conflicts @@ -82,7 +83,7 @@ hg diff hg revert hg remove hg update -You have seen that it is possible to switch revision using 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 @@ -97,7 +98,7 @@ $ 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. +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 @@ -117,7 +118,7 @@ Bookmarks are tags that move forward automatically to subsequent changes, leavin 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. +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. @@ -150,7 +151,7 @@ This is a good tutorial: https://www.digitalocean.com/community/tutorials/how-to git lg git checkout master -git merge search | git merge --no-ff search +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) @@ -159,7 +160,7 @@ 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: +with merge conflicts: git status (shows you all the files that can't be added due to merge conflicts) fix the conflicts @@ -179,4 +180,3 @@ From the interface, you can also create a pull request to merge all of the chang | see what has changed since last commit | `git diff` | | commit changes | `git commit` | | | | - diff --git a/mydoc/mydoc_glossary.md b/mydoc/mydoc_glossary.md index 02168ee..9461374 100644 --- a/mydoc/mydoc_glossary.md +++ b/mydoc/mydoc_glossary.md @@ -7,10 +7,11 @@ summary: "Your glossary page can take advantage of definitions stored in a data sidebar: mydoc_sidebar permalink: /mydoc_glossary/ 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. +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: @@ -38,7 +39,7 @@ Then create a page and use definition list formatting, like this: ``` -Here's what that looks like: +Here's what that looks like:
@@ -90,6 +91,6 @@ You can also change the definition list (`dl`) class to `dl-horizontal`. This is
-If you squish your screen small enough, at a certain breakpoint this style reverts to the regular `dl` class. +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. diff --git a/mydoc/mydoc_help_api.md b/mydoc/mydoc_help_api.md index 2c2e7d9..f005301 100644 --- a/mydoc/mydoc_help_api.md +++ b/mydoc/mydoc_help_api.md @@ -6,6 +6,7 @@ keywords: API, content API, UI text, inline help, context-sensitive help, popove 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/ +folder: mydoc --- ## Full code demo of content API @@ -22,7 +23,7 @@ Additionally, instead of tooltip popovers, you could also print content directly ## Diagram overview -Here's a diagram showing the basic idea of the help API: +Here's a diagram showing the basic idea of the help API: @@ -34,7 +35,7 @@ To deliver help this way using Jekyll, follow the steps in each of the sections ## 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." +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: @@ -110,7 +111,7 @@ search: exclude Change "mydoc" to the product name you used in each of the tooltip files. The template here will only include content in the JSON file if it meets the `product` attribute requirements. We need this `if` statement to prevent tooltips from other products from being included in the JSON file. -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: +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: ``` { @@ -151,13 +152,13 @@ When you build your site, Jekyll will iterate through every page in your \_toolt ## 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. +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. +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. +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. +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: @@ -165,7 +166,7 @@ If your server setup allows htaccess files to override general server permission 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. +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. @@ -175,7 +176,7 @@ To test whether your server permissions are set correctly, open a terminal and r curl -I http://idratherassets.com/wp-content/apidemos/tooltips.json ``` -The `-I` command tells cURL to return the request header only. +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: @@ -183,7 +184,7 @@ If the server permissions are set correctly, you should see the following line s Access-Control-Allow-Origin: * ``` -If you don't see this response, CORS isn't allowed for the file. +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: @@ -200,7 +201,7 @@ If you have an AWS S3 bucket, you can supposedly add a CORS configuration to the 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. +If you don't have CORS enabled, users will see a CORS error/warning message in the console of the page making the request. {{site.data.alerts.tip}} 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. {{site.data.alerts.end}} @@ -224,14 +225,14 @@ $.get( url, function( data ) { }); }); - + }); {% endraw %} ``` View the tooltip demo for a demo. -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 `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. @@ -247,7 +248,7 @@ Here's the section on the page where the popover is inserted: 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: +In order to use jQuery and Bootstrap, you'll need to add the appropriate references in the head tags of your page: ```js @@ -267,13 +268,13 @@ Again, see the Tooltip Demo for a dem 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. +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 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. +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: @@ -314,7 +315,7 @@ Here's how you would reuse the content: {% endraw %} ``` -And here's the code: +And here's the code:

Reuse Demo

@@ -350,4 +351,4 @@ And here's the code: -Now you have both documentation and UI tooltips generated from the same definitions file. \ No newline at end of file +Now you have both documentation and UI tooltips generated from the same definitions file. diff --git a/mydoc/mydoc_hyperlinks.md b/mydoc/mydoc_hyperlinks.md index 1cce38f..34cc497 100644 --- a/mydoc/mydoc_hyperlinks.md +++ b/mydoc/mydoc_hyperlinks.md @@ -7,6 +7,7 @@ summary: "When creating links, you can use standard HTML or Markdown formatting. last_updated: March 20, 2016 sidebar: mydoc_sidebar permalink: /mydoc_hyperlinks/ +folder: mydoc --- ## Create an external link @@ -40,10 +41,10 @@ OR ## Managed Links You can also adopt an indirect-reference systems for managing links. This "managed links" approach involves storing the link text in YAML syntax. - -Look at the urls.txt file in the root directory. The urls.txt file contains more or less the same code as the table of contents (but without the conditional qualifiers). A `for` loop runs each of the product sidebars listed in the frontmatter through the url generator. -The code iterates through every page listed in the table of contents sidebars (as well as the top navigation menus) and creates an output that looks like this for each link: +Look at the urls.txt file in the root directory. The urls.txt file contains more or less the same code as the table of contents (but without the conditional qualifiers). A `for` loop runs each of the product sidebars listed in the frontmatter through the url generator. + +The code iterates through every page listed in the table of contents sidebars (as well as the top navigation menus) and creates an output that looks like this for each link: ```yaml mydoc_introduction: @@ -73,8 +74,8 @@ From the site output folder (in \_site), open urls.txt and observe that it is pr This will move and rename the file through a script. -Because the urls.txt is produced from the table of contents, you ensure that the same titles and URLs used in your table of contents and top navigation will also be used in your inline links. - +Because the urls.txt is produced from the table of contents, you ensure that the same titles and URLs used in your table of contents and top navigation will also be used in your inline links. + To create a link in a topic, just reference the appropriate value in the urls.yml file, like this: {% raw %} @@ -89,7 +90,7 @@ This will insert the following into your topic: Getting started ``` -You don't need to worry whether you can use Markdown syntax when inserting a link this way, because the code that gets inserted is HTML. +You don't need to worry whether you can use Markdown syntax when inserting a link this way, because the code that gets inserted is HTML. To insert a link in the context of a phrase, you can use this syntax: @@ -101,7 +102,7 @@ After downloading the theme, you can [get started in building the theme]({{site. Note that `.url` is used instead of `.link` when using customized text links like this. -If you're in HTML and can't use Markdown, then use the following code: +If you're in HTML and can't use Markdown, then use the following code: {% raw %} ```html @@ -112,7 +113,7 @@ If you're in HTML and can't use Markdown, then use the following code: The `url` value accesses the URL for the page only, whereas `link` gets the title and url in a link format. You shouldn't have to transfer the contents from the urls.txt file into your YAML data source too often — only when you're creating new pages. - + I also added a simple script called "run.sh" that performs the urls-update.sh command prior to running Jekyll serve, so you can kill two birds with one stone. Note that for the index.html file, which doesn't have a permalink, this file is not included in the urls.txt generation. The frontmatter in the index.md file (`type: homepage`) triggers an exclusion from urls.txt because the empty name makes the yaml file invalid. To link to the homepage, just refer users to the root url of your site {% raw %}(`{{site.url}}` or `{{site.url}}{{site.baseurl}}`{% endraw %}). @@ -141,7 +142,7 @@ Or using HTML: {%raw%}{{site.data.urls.your-page-permalink.title}}{%endraw%} ``` -Granted, this is somewhat long, but it's the only way to continue to leverage the automated links from urls.yaml. You want to avoid manually referencing links since they are much more prone to break when you specify them that way. +Granted, this is somewhat long, but it's the only way to continue to leverage the automated links from urls.yaml. You want to avoid manually referencing links since they are much more prone to break when you specify them that way. However, I'm not too worried about this lengthy syntax because I think linking to sections on pages is somewhat fragile anyway. When you're editing sections, you generally don't know what URLs you have pointing to that section. The custom ID tag on that section is the best reminder that you are linking to the section. @@ -155,7 +156,7 @@ If you're just linking to a section on the same page, the syntax is simple: ## How to tell what links point to a page -There's no automated way to tell what links you have pointing to a page. This is one of the shortcomings of static site generators. The only way is to search your project for the page title. This is simple in Webstorm (Cmd + Shift + F), and it's one of the reasons I like Webstorm. +There's no automated way to tell what links you have pointing to a page. This is one of the shortcomings of static site generators. The only way is to search your project for the page title. This is simple in Webstorm (Cmd + Shift + F), and it's one of the reasons I like Webstorm. If you change a page title, you generally want to search in your project and update all references to the page to the new page name. You can do this easily through the Global Replace command (Cmd + Shift + R). @@ -165,7 +166,7 @@ If you change a page title, you generally want to search in your project and upd You should treat your sidebar data files (in /_data/sidebars) with a lot of care. Every time you add a page to your site, make sure it's listed in your sidebar file (or in your top navigation). If you don't have pages listed in your sidebar file, they won't be included in the urls.txt file, and as your site grows, it will be harder to recognize pages that are absent from the TOC. Because all the pages are stored in the root directory, the list of files can grow really long. I typically find pages by navigating to the page in the preview server, copying the page name (e.g., mydoc_hyperlinks), and then pressing **Shift + Shift** in WebStorm to locate the page. - + This is the only sane way to locate your pages when you have hundreds of pages in your root directory. If the page isn't listed in your TOC, it will be difficult to navigate to it and find it. ## Checking for broken links @@ -177,7 +178,7 @@ One way to ensure you don't have any broken links in your output is to [generate Both instances indicate a broken link. The "page 0" indicates that Prince XML couldn't find the page that the link points to, and so it can't create a cross reference. This may be because the page doesn't exist, or because the anchor is pointing to a missing location. -If you see "see ." it means that the reference (for example, {% raw %}`{{mylink...}}`{% endraw %} doesn't actually refer to anything. As a result, it's simply blank in the output. +If you see "see ." it means that the reference (for example, {% raw %}`{{mylink...}}`{% endraw %} doesn't actually refer to anything. As a result, it's simply blank in the output. {{site.data.alerts.note}} To keep Prince XML from trying to insert a cross reference into a link, add class="noCrossRef" to the link. {{site.data.alerts.end}} @@ -187,4 +188,4 @@ In general, avoid broken links and outdated titles in links by doing the followi * Where possible, avoid using the exact titles in link names. For example, if you write, see the Links page, this title is likely to become more outdated than if you were to write, learn how to manage links. * Use a broken link checker on your site output to see if links are broken. -* Generate a PDF, since the PDF tends to highlight broken links more forcefully. \ No newline at end of file +* Generate a PDF, since the PDF tends to highlight broken links more forcefully. diff --git a/mydoc/mydoc_icons.md b/mydoc/mydoc_icons.md index ca1dba3..ebce3fe 100644 --- a/mydoc/mydoc_icons.md +++ b/mydoc/mydoc_icons.md @@ -6,6 +6,7 @@ last_updated: March 20, 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/ +folder: mydoc --- ## Font icon options @@ -132,7 +133,7 @@ Then any element with the attribute `fa-10x` will be enlarged 1700%. ## Glyphicon icons available -Glyphicons work similarly to Font Awesome. Go to the [Glyphicons library](http://getbootstrap.com/components/#glyphicons) to see the icons available. +Glyphicons work similarly to Font Awesome. Go to the [Glyphicons library](http://getbootstrap.com/components/#glyphicons) to see the icons available. Although the Glyphicon Halflings library doesn't provide the scalable classes like Font Awesome, there's a [StackOverflow trick](http://stackoverflow.com/questions/24960201/how-do-i-make-glyphicons-bigger-change-size) to make the icons behave in a similar way. This theme's stylesheet (customstyles.css) includes the following to the stylesheet: @@ -153,7 +154,7 @@ And here's the result: -Glypicons use the `span` element instead of `i` to attach their classes. +Glypicons use the `span` element instead of `i` to attach their classes. Here's another example: @@ -211,15 +212,14 @@ Here's the result: You can use any of the following: {% raw %} ``` -{{site.data.alerts.callout_default}} -{{site.data.alerts.callout_primary}} -{{site.data.alerts.callout_success}} -{{site.data.alerts.callout_info}} -{{site.data.alerts.callout_warning}} +{{site.data.alerts.callout_default}} +{{site.data.alerts.callout_primary}} +{{site.data.alerts.callout_success}} +{{site.data.alerts.callout_info}} +{{site.data.alerts.callout_warning}} ``` {% endraw %} -The only difference is the color of the left bar. +The only difference is the color of the left bar. Callouts are explained in a bit more detail in Alerts. - diff --git a/mydoc/mydoc_images.md b/mydoc/mydoc_images.md index 3fe0814..b694ebe 100644 --- a/mydoc/mydoc_images.md +++ b/mydoc/mydoc_images.md @@ -6,6 +6,7 @@ last_updated: March 20, 2016 summary: "Store images in the images folder and use the image.html include to insert images. This include has several options, including figcaptions, that extract the content from the formatting." sidebar: mydoc_sidebar permalink: /mydoc_images/ +folder: mydoc --- ## Image Include Template diff --git a/mydoc/mydoc_install_jekyll_on_mac.md b/mydoc/mydoc_install_jekyll_on_mac.md index a5e3e5e..1645efa 100644 --- a/mydoc/mydoc_install_jekyll_on_mac.md +++ b/mydoc/mydoc_install_jekyll_on_mac.md @@ -5,33 +5,34 @@ keywords: summary: "Installation of Jekyll on Mac is usually less problematic than on Windows. However, you may run into permissions issues with Ruby that you must overcome. You should also use Bundler to be sure that you have all the required gems and other utilities on your computer to make the project run. " sidebar: mydoc_sidebar permalink: /mydoc_install_jekyll_on_mac/ +folder: mydoc --- ## Ruby and RubyGems Ruby and [RubyGems](https://rubygems.org/pages/download) are usually installed by default on Macs. Open your Terminal and type `which ruby` and `which gem` to confirm that you have Ruby and Rubygems. You should get a response indicating the location of Ruby and Rubygems. - + If you get responses that look like this: ``` /usr/local/bin/ruby ``` -and +and ``` /usr/local/bin/gem ``` Great! Skip down to the [Bundler](#bundler) section. - + However, if your location is something like `/Users/MacBookPro/.rvm/rubies/ruby-2.2.1/bin/gem`, which points to your system location of Rubygems, you will likely run into permissions errors when trying to get a gem. A sample permissions error (triggered when you try to install the jekyll gem such as `gem install jekyll`) might look like this for Rubygems: - + ``` >ERROR: While executing gem ... (Gem::FilePermissionError) You don't have write permissions for the /Library/Ruby/Gems/2.0.0 directory. ``` - + Instead of changing the write permissions on your operating system's version of Ruby and Rubygems (which could pose security issues), you can install another instance of Ruby (one that is writable) to get around this. ## Install Homebrew @@ -56,7 +57,7 @@ Now use Homebrew to install Ruby: brew install ruby ``` -Log out of terminal, and then then log back in. +Log out of terminal, and then then log back in. When you type `which ruby` and `which gem`, you should get responses like this: @@ -76,7 +77,7 @@ Note that if you don't see these paths, try restarting your computer or try inst

Install the Jekyll gem

-At this point you should have a writeable version of Ruby and Rubygem on your machine. +At this point you should have a writeable version of Ruby and Rubygem on your machine. Now use `gem` to install Jekyll: @@ -90,7 +91,7 @@ You can now use Jekyll to create new Jekyll sites following the quick-start inst Some Jekyll themes will require certain Ruby gem dependencies. These dependencies are stored in something called a Gemfile, which is packaged with the Jekyll theme. You can install these dependencies through Bundler. (Although you don't need to install Bundler for this Documentation theme, it's a good idea to do so.) -[Bundler](http://bundler.io/) is a package manager for RubyGems. You can use it to get all the gems (or Ruby plugins) that you need for your Jekyll project. +[Bundler](http://bundler.io/) is a package manager for RubyGems. You can use it to get all the gems (or Ruby plugins) that you need for your Jekyll project. You install Bundler by using the gem command with RubyGems: @@ -108,4 +109,4 @@ The vanilla Jekyll site you create through `jekyll new my-awesome-site` doesn't 1. Browse to the directory where you downloaded the Documentation theme for Jekyll. 2. Type `jekyll serve` -3. Go to the preview address in the browser. (Make sure you include the `/` at the end.) \ No newline at end of file +3. Go to the preview address in the browser. (Make sure you include the `/` at the end.) diff --git a/mydoc/mydoc_install_jekyll_on_windows.md b/mydoc/mydoc_install_jekyll_on_windows.md index 3a82a3f..092eacf 100644 --- a/mydoc/mydoc_install_jekyll_on_windows.md +++ b/mydoc/mydoc_install_jekyll_on_windows.md @@ -3,15 +3,16 @@ title: Install Jekyll on Windows permalink: /mydoc_install_jekyll_on_windows/ keywords: jekyll on windows, pc, ruby, ruby dev kit sidebar: mydoc_sidebar +folder: mydoc --- {{site.data.alerts.tip}} For a better terminal emulator on Windows, use [Git Bash](https://git-for-windows.github.io/). Git Bash gives you Linux-like control on Windows. {{site.data.alerts.end}} ## Install Ruby -First you must install Ruby because Jekyll is a Ruby-based program and needs Ruby to run. +First you must install Ruby because Jekyll is a Ruby-based program and needs Ruby to run. -1. Go to [RubyInstaller for Windows](http://rubyinstaller.org/downloads/). +1. Go to [RubyInstaller for Windows](http://rubyinstaller.org/downloads/). 2. Under **RubyInstallers**, download and install one of the Ruby installers (usually one of the first two options). 3. Double-click the downloaded file and proceed through the wizard to install it. @@ -19,14 +20,14 @@ First you must install Ruby because Jekyll is a Ruby-based program and needs Rub Some extensions Jekyll uses require you to natively build the code using the Ruby Development Kit. -1. Go to [RubyInstaller for Windows](http://rubyinstaller.org/downloads/). +1. Go to [RubyInstaller for Windows](http://rubyinstaller.org/downloads/). 2. Under the **Development Kit** section near the bottom, download one of the **For use with Ruby 2.0 and above...** options (either the 32-bit or 64-bit version). 3. Move your downloaded file onto your **C** drive in a folder called something like **RubyDevKit**. 4. Extract the compressed folder's contents into the folder. 5. Browse to the **RubyDevKit** location on your C drive using your Command Line Prompt. - + To see the contents of your current directory, type dir. To move into a directory, type cd foldername, where "foldername" is the name of the folder you want to enter. To move up a directory, type cd ../ one or more times depending on how many levels you want to move up. To move into your user's directory, type /users. The / at the beginning of the path automatically starts you at the root. - + 6. Type `ruby dk.rb init` 7. Type `ruby dk.rb install` @@ -34,7 +35,7 @@ If you get stuck, see the [official instructions for installing Ruby Dev Kit](ht

Install the Jekyll gem

-At this point you should have Ruby and Rubygem on your machine. +At this point you should have Ruby and Rubygem on your machine. Now use `gem` to install Jekyll: @@ -48,7 +49,7 @@ You can now use Jekyll to create new Jekyll sites following the quick-start inst Some Jekyll themes will require certain Ruby gem dependencies. These dependencies are stored in something called a Gemfile, which is packaged with the Jekyll theme. You can install these dependencies through Bundler. (Although you don't need to install Bundler for this Documentation theme, it's a good idea to do so.) -[Bundler](http://bundler.io/) is a package manager for RubyGems. You can use it to get all the gems (or Ruby plugins) that you need for your Jekyll project. +[Bundler](http://bundler.io/) is a package manager for RubyGems. You can use it to get all the gems (or Ruby plugins) that you need for your Jekyll project. You install Bundler by using the gem command with RubyGems: @@ -57,26 +58,26 @@ You install Bundler by using the gem command with RubyGems: 1. Install Bundler: `gem install bundler` 2. Initialize Bundler: `bundle init` - + This will create a new Gemfile. - -3. Open the Gemfile in a text editor. - + +3. Open the Gemfile in a text editor. + Typically you can open files from the Command Prompt by just typing the filename, but because Gemfile doesn't have a file extension, no program will automatically open it. You may need to use your File Explorer and browse to the directory, and then open the Gemfile in a text editor such as Notepad. - -4. Remove the existing contents. Then paste in the following: - + +4. Remove the existing contents. Then paste in the following: + ``` source "https://rubygems.org" - + gem 'wdm' gem 'jekyll' ``` - The [wdm gem](https://rubygems.org/gems/wdm/versions/0.1.1) allows for the polling of the directory and rebuilding of the Jekyll site when you make changes. This gem is needed for Windows users, not Mac users. - + The [wdm gem](https://rubygems.org/gems/wdm/versions/0.1.1) allows for the polling of the directory and rebuilding of the Jekyll site when you make changes. This gem is needed for Windows users, not Mac users. + 6. Save and close the file. 7. Type `bundle install`. - + Bundle retrieves all the needed gems and gem dependencies and downloads them to your computer. At this time, Bundle also takes a snapshot of all the gems used in your project and creates a Gemfile.lock file to store this information. ## Serve the Jekyll Documentation theme @@ -84,5 +85,5 @@ You install Bundler by using the gem command with RubyGems: 1. Browse to the directory where you downloaded the Documentation theme for Jekyll. 2. Type `jekyll serve` 3. Go to the preview address in the browser. (Make sure you include the `/` at the end.) - + Unfortunately, the Command Prompt doesn't allow you to easily copy and paste the URL, so you'll have to type it manually. diff --git a/mydoc/mydoc_installing_bundler.md b/mydoc/mydoc_installing_bundler.md index 70d5c63..037fbc5 100644 --- a/mydoc/mydoc_installing_bundler.md +++ b/mydoc/mydoc_installing_bundler.md @@ -3,38 +3,39 @@ title: Installing Bundler published: false sidebar: mydoc_sidebar permalink: /mydoc_installing_bundler/ +folder: mydoc --- If you get permissions errors when trying to install Bundler, follow these steps: - + if you get a permissions error when trying to install bundler, then do this: Install Brew: /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" Install rbenv, a Ruby Version Mgmt Tool: brew install rbenv - + Initialize rbenv: rbenv init - + Log out of terminal or iTerm, and then back in Install bundler: gem install bundler Now you can use Bundler to get any project dependencies you need. Usually you would add a gemfile to your project and then use Bundler to install the gems and all the dependencies you need. Create a gemfile: bundle init - + Open the gemfile: open gemfile - + Paste in the gems you want bundler to get for you: source 'https://rubygems.org' gem 'github-pages' gem 'pygments.rb' gem 'redcarpet' gem 'jekyll' - + Run Bundler: bundle install Execute Bundler against your project: bundle exec jekyll serve -(Instead of jekyll serve, run one of the other build commands.) \ No newline at end of file +(Instead of jekyll serve, run one of the other build commands.) diff --git a/mydoc/mydoc_introduction.md b/mydoc/mydoc_introduction.md index 52a4715..f538e22 100644 --- a/mydoc/mydoc_introduction.md +++ b/mydoc/mydoc_introduction.md @@ -2,6 +2,7 @@ title: Introduction sidebar: mydoc_sidebar permalink: /mydoc_introduction/ +folder: mydoc --- ## Overview diff --git a/mydoc/mydoc_iterm_profiles.md b/mydoc/mydoc_iterm_profiles.md index 822d3fd..c2a2609 100644 --- a/mydoc/mydoc_iterm_profiles.md +++ b/mydoc/mydoc_iterm_profiles.md @@ -1,11 +1,12 @@ --- -title: iTerm profiles +title: iTerm profiles tags: [publishing] keywords: iterm, terminal, build shortcuts, mac last_updated: March 20, 2016 summary: "You can set up profiles in iTerm to facilitate the build process with just a few clicks. This can make it a lot easier to quickly build multiple outputs." sidebar: mydoc_sidebar permalink: /mydoc_iterm_profiles/ +folder: mydoc --- ## About iTerm profiles @@ -24,7 +25,7 @@ When you're working with tech docs, a lot of times you have builds that push fil JEKYLL_ENV=production jekyll serve ``` Leave the Login shell option selected. - + 6. In the Working Directory section, select **Directory** and enter the directory for your project, such as **/Users/tjohnson/projects/documentation-theme-jekyll**. 7. Close the profiles panel. @@ -37,4 +38,4 @@ Here's an example: 1. In iTerm, make sure the Toolbar is shown. Go to **View > Toggle Toolbar**. 2. Click the **New** button and select your profile. -{{site.data.alerts.tip}} When you're done with the session, make sure to click Ctrl+C.{{site.data.alerts.end}} \ No newline at end of file +{{site.data.alerts.tip}} When you're done with the session, make sure to click Ctrl+C.{{site.data.alerts.end}} diff --git a/mydoc/mydoc_kb_layout.md b/mydoc/mydoc_kb_layout.md index 602dc8a..a634ecd 100644 --- a/mydoc/mydoc_kb_layout.md +++ b/mydoc/mydoc_kb_layout.md @@ -7,6 +7,7 @@ summary: "This shows a sample layout for a knowledge base. Each square could lin sidebar: mydoc_sidebar permalink: /mydoc_kb_layout/ toc: false +folder: mydoc --- Here's the sample knowledge-base style layout: @@ -76,8 +77,8 @@ Here's the sample knowledge-base style layout: - - + + ## Generating a list of all pages with a certain tag If you don't want to link to a tag archive index, but instead want to list all pages that have a certain tag, you could use this code: @@ -92,7 +93,7 @@ If you don't want to link to a tag archive index, but instead want to list all p
  • {{page.title}}
    • {% endif %} {% endfor %} -{% endfor %} +{% endfor %} {% endraw %} ``` @@ -108,5 +109,5 @@ Getting started pages:
  • {{page.title}}
    • {% endif %} {% endfor %} -{% endfor %} - \ No newline at end of file +{% endfor %} + diff --git a/mydoc/mydoc_labels.md b/mydoc/mydoc_labels.md index bd301bb..a32d4a4 100644 --- a/mydoc/mydoc_labels.md +++ b/mydoc/mydoc_labels.md @@ -6,9 +6,9 @@ last_updated: March 20, 2016 summary: "Labels are just a simple Bootstrap component that you can include in your pages as needed. They represent one of many Bootstrap options you can include in your theme." sidebar: mydoc_sidebar permalink: /mydoc_labels/ +folder: mydoc --- - ## About labels Labels might come in handy for adding button-like tags next to elements, such as POST, DELETE, UPDATE methods for endpoints. You can use any classes from Bootstrap in your content. @@ -28,4 +28,4 @@ Labels might come in handy for adding button-like tags next to elements, such as Warning Danger -You can have a label appear within a heading simply by including the span tag in the heading. However, you can't mix Markdown syntax with HTML, so you'd have to hard-code the heading ID for the auto-TOC to work. \ No newline at end of file +You can have a label appear within a heading simply by including the span tag in the heading. However, you can't mix Markdown syntax with HTML, so you'd have to hard-code the heading ID for the auto-TOC to work. diff --git a/mydoc/mydoc_navtabs.md b/mydoc/mydoc_navtabs.md index f672e63..dac53d3 100644 --- a/mydoc/mydoc_navtabs.md +++ b/mydoc/mydoc_navtabs.md @@ -6,12 +6,13 @@ last_updated: March 20, 2016 summary: "Navtabs provide a tab-based navagation directly in your content, allowing users to click from tab to tab to see different panels of content. Navtabs are especially helpful for showing code samples for different programming languages. The only downside to using navtabs is that you must use HTML instead of Markdown." sidebar: mydoc_sidebar permalink: /mydoc_navtabs/ +folder: mydoc --- ## Common uses -Navtabs are particularly useful for scenarios where you want to show a variety of options, such as code samples for Java, .NET, or PHP, on the same page. +Navtabs are particularly useful for scenarios where you want to show a variety of options, such as code samples for Java, .NET, or PHP, on the same page. While you could resort to single-source publishing to provide different outputs for each unique programming language or role, you could also use navtabs to allow users to select the content you want. @@ -20,15 +21,15 @@ Navtabs are better for SEO since you avoid duplicate content and drive users to ## Navtabs demo The following is a demo of a navtab. Refresh your page to see the tab you selected remain active. - + -
    +
    -

    Profile

    +

    Profile

    Praesent sit amet fermentum leo. Aliquam feugiat, nibh in u ltrices mattis, felis ipsum venenatis metus, vel vehicula libero mauris a enim. Sed placerat est ac lectus vestibulum tempor. Quisque ut condimentum massa. Proin venenatis leo id urna cursus blandit. Vivamus sit amet hendrerit metus.

    @@ -52,9 +53,9 @@ Here's the code for the above (with the filler text abbreviated):
  • About
  • Match
    • -
    +
    -

    Profile

    +

    Profile

    Praesent sit amet fermentum leo....

    @@ -94,11 +95,10 @@ One of the tabs needs to be set as active, depending on what tab you want to be ## Sets a cookie -The navtabs are part of Bootstrap, but this theme sets a cookie to remember the last tab's state. The js/customscripts.js file has a long chunk of JavaScript that sets the cookie. The JavaScript comes from [this StackOverflow thread](http://stackoverflow.com/questions/10523433/how-do-i-keep-the-current-tab-active-with-twitter-bootstrap-after-a-page-reload). +The navtabs are part of Bootstrap, but this theme sets a cookie to remember the last tab's state. The js/customscripts.js file has a long chunk of JavaScript that sets the cookie. The JavaScript comes from [this StackOverflow thread](http://stackoverflow.com/questions/10523433/how-do-i-keep-the-current-tab-active-with-twitter-bootstrap-after-a-page-reload). By setting a cookie, if the user refreshes the page, the active tab is the tab the user last selected (rather than defaulting to the default active tab). ## Functionality to implement One piece of functionality I'd like to implement is the ability to set site-wide nav tab options. For example, if the user always chooses PHP instead of Java in the code samples, it would be great to set this option site-wide by default. However, this functionality isn't yet coded. - diff --git a/mydoc/mydoc_no_password_prompts_scp.md b/mydoc/mydoc_no_password_prompts_scp.md index 9b34bc1..a1c17f0 100644 --- a/mydoc/mydoc_no_password_prompts_scp.md +++ b/mydoc/mydoc_no_password_prompts_scp.md @@ -4,6 +4,7 @@ sidebar: mydoc_sidebar tags: [publishing, troubleshooting] permalink: /mydoc_no_password_prompts_scp/ summary: "You can publish your docs via SSH through a Terminal window or more likely, via a shell script that you simply execute as part of the publishing process. However, you will be prompted for your password with each file transfer unless you configure passwordless SSH. The basic process for setting up password less SSH is to create a key on your own machine that you also transfer to the remote machine. When you use the SCP command, the remote machine checks that you have the authorized key and allows access without a password prompt." +folder: mydoc --- ## Get rid of password prompts @@ -16,19 +17,19 @@ To remove the password prompts when connecting to servers via SSH: ``` cd ~/.ssh ``` - + Note that any directory that starts with a dot, like .ssh, is hidden. You can view hidden folders by enabling them on your Mac. See [this help topic](http://ianlunn.co.uk/articles/quickly-showhide-hidden-files-mac-os-x-mavericks/). Additionally, when you look at the files in a directory, use ls -a instead of just ls to view the hidden files. - - If you don't have an .ssh directory, create one with `mkdir .ssh`. - + + If you don't have an .ssh directory, create one with `mkdir .ssh`. + 2. Create a new key inside your .ssh directory: - + ``` ssh-keygen -t rsa ``` - + 3. Press **Enter**. When prompted about "Enter file in which to save the key ...", press ```Enter``` again. - + This will create a file called id_rsa.pub (the key) and id_rsa (your identification) in this .ssh folder. When prompted for a passphrase for the key, just leave it empty and press **Enter** twice. You should see something like this: @@ -45,7 +46,7 @@ To remove the password prompts when connecting to servers via SSH: ``` The key's randomart image is: - + ``` +--[ RSA 2048]----+ |. | @@ -59,9 +60,9 @@ To remove the password prompts when connecting to servers via SSH: | *.o | +-----------------+ ``` - + As you can see, RSA draws a picture for you. Take a screenshot of the picture, print it out, and put it up on your fridge. - + 4. Open up another terminal window (in iTerm, open another tab), and SSH in to your remote server: ``` @@ -69,61 +70,61 @@ To remove the password prompts when connecting to servers via SSH: ``` 5. Change `` to your actual username, such as tjohnson. - - When you connect, you'll be prompted for your password. - + + When you connect, you'll be prompted for your password. + When you connect, by default you are routed to the personal folder on the directory. For example, `/home/remoteserver/`. To see this directory, type `pwd` (or `dir` on Windows). - + 6. Create a new directory called .ssh on remoteserver.com server inside the `/home/remoteserver/` directory. - + ``` mkdir -p .ssh ``` - + You can ensure that it's there with this command: - + ``` ls -a ``` - + Without the -a, the hidden directory won't be shown. 7. Open another Terminal window and browse to /Users//.ssh on your local machine. - + ``` cd ~/.ssh ``` - + 8. Copy the id_rsa.pub from the /.ssh directory on your local machine to the /home/remoteserver//.ssh directory on the remoteserver server: - + ``` scp id_rsa.pub @yourserver.com:/home/remoteserver//.ssh ``` - + 9. Switch back into your terminal window that is connected to remoteserver.com, change directory to the .ssh directory, and rename the file from id_rsa.pub to `authorized_keys` (without any file extension): - + ``` mv id_rsa.pub authorized_keys ``` - + 10. Change the file permissions to 700: - + ``` chmod 700 authorized_keys ``` - + Now you should be able to SSH onto remoteserver without any password prompts. - + 11. Open another terminal (which is not already SSH'd into remoteserver.com) and try the following: - + ``` ssh @remoteserver.com ``` - + If successful, you shouldn't be prompted for a password. - + Now that you can connect without password prompts, you can use the scp scripts to transfer files to the server without password prompts. For example: - + ``` scp -r ../doc_outputs/mydoc/writers @remoteserver:/var/www/html/ - ``` \ No newline at end of file + ``` diff --git a/mydoc/mydoc_pages.md b/mydoc/mydoc_pages.md index 7bf503e..d0a671a 100644 --- a/mydoc/mydoc_pages.md +++ b/mydoc/mydoc_pages.md @@ -6,10 +6,11 @@ last_updated: March 20, 2016 summary: "This theme primarily uses pages. You need to make sure your pages have the appropriate frontmatter. One frontmatter tag your users might find helpful is the summary tag. This functions similar in purpose to the shortdesc element in DITA." sidebar: mydoc_sidebar permalink: /mydoc_pages/ +folder: mydoc --- ## Where to author content -Use a text editor such as Sublime Text, WebStorm, IntelliJ, or Atom to create pages. +Use a text editor such as Sublime Text, WebStorm, IntelliJ, or Atom to create pages. My preference is IntelliJ/WebStorm, since it will treat all files in your theme as belonging to a project. This allows you to easily search for instances of keywords, do find-and-replace operations, or do other actions that apply across the whole project. @@ -17,7 +18,7 @@ My preference is IntelliJ/WebStorm, since it will treat all files in your theme By default, everything in your project is included in the output. You can exclude all files that don't belong to that project by specifying the file name, the folder name, or by using wildcards in your configuration file: -exclude: +exclude: - filename.md - subfolder_name/ @@ -59,7 +60,7 @@ The following table describes each of the frontmatter that you can use with this | **datatable** | Optional | 'true'. If you add `datatable: true` in the frontmatter, scripts for the [jQuery Datatables plugin](https://www.datatables.net/) get included on the page. You can see the scripts that conditionally appear by looking in the \_layouts/default.html page. | | toc | Optional | If you specify `toc: false` in the frontmatter, the page won't have the table of contents that appears below the title. The toc refers to the list of jump links below the page title, not the sidebar navigation. You probably want to hide the TOC on the homepage and product landing pages.| -## Colons in page titles +## Colons in page titles If you want to use a colon in your page title, you must enclose the title's value in quotation marks. @@ -72,7 +73,7 @@ If you add `published: false` in the frontmatter, your page won't be published. ## Markdown or HTML format Pages can be either Markdown or HTML format (specified through either an .md or .html file extension). - + If you use Markdown, you can also include HTML formatting where needed. But not vice versa — if you use HTML (as your file extension), you can't insert Markdown content in the file. Also, if you use HTML inside a Markdown file, you cannot use Markdown inside of HTML. But you can use HTML inside of Markdown. @@ -83,11 +84,11 @@ If you have a lot of HTML, as long as the top and bottom tags of the HTML are fl ## Where to save pages -You can store your pages in any folder structures you want, with any level of folder nesting. The site output will pull all of those pages out of their folders and put them into the root directory. Check out the \_site folder, which is where Jekyll is generated, to see the difference between your project's structure and the resulting site output. - +You can store your pages in any folder structures you want, with any level of folder nesting. The site output will pull all of those pages out of their folders and put them into the root directory. Check out the \_site folder, which is where Jekyll is generated, to see the difference between your project's structure and the resulting site output. + ## Page names -I recommend prefixing your page names with the product, such as "mydoc_pages" instead of just "pages." This way if you have other products that also hae topics with generic names such as "pages," there won't be naming conflicts. +I recommend prefixing your page names with the product, such as "mydoc_pages" instead of just "pages." This way if you have other products that also hae topics with generic names such as "pages," there won't be naming conflicts. Additionally, consider adding the product name in parentheses after the title, such as "Pages (Mydoc)" so that users can clearly navigate different topics for each product. @@ -121,12 +122,12 @@ You can create other layouts inside the layouts folder. If you create a new layo ## Comments -Disqus, a commenting system, is integrated into the theme. In the configuration file, specify the Disqus code for the universal code, and Disqus will appear. If you don't add a Disqus value, the Disqus form isn't included. +Disqus, a commenting system, is integrated into the theme. In the configuration file, specify the Disqus code for the universal code, and Disqus will appear. If you don't add a Disqus value, the Disqus form isn't included. ## Custom keyboard shortcuts Some of the Jekyll syntax can be slow to create. Using a utility such as [aText](https://www.trankynam.com/atext/) can make creating content a lot of faster. -For example, with my aText configuration, when I type `jlink`, aText replaces it with {% raw %}`page`{% endraw %}. +For example, with my aText configuration, when I type `jlink`, aText replaces it with {% raw %}`page`{% endraw %}. You get aText from the App Store on a Mac for about $5. However, the Mac Store version of aText won't work on Mac OSX El Capitan due to sandbox security restrictions, so you need to download the app outside of the App Store to make it work. diff --git a/mydoc/mydoc_posts.md b/mydoc/mydoc_posts.md index 7d52cf8..1082df1 100644 --- a/mydoc/mydoc_posts.md +++ b/mydoc/mydoc_posts.md @@ -6,15 +6,16 @@ last_updated: Feb 25, 2016 summary: "You can use posts when you want to create blogs or news type of content." sidebar: mydoc_sidebar permalink: /mydoc_posts/ +folder: mydoc --- ## About posts - -Posts are typically used for blogs or other news information because they contain a date and are sorted in reverse chronological order. + +Posts are typically used for blogs or other news information because they contain a date and are sorted in reverse chronological order. You create a post by adding a file in the \_posts folder that is named yyyy-mm-dddd-permalink.md, which might be 2016-02-25-my-latest-updates.md. You can use any number of subfolders here that you want. -Posts use the post.html layout in the \_layouts folder when you are viewing the post. +Posts use the post.html layout in the \_layouts folder when you are viewing the post. The news.html file in the root directory shows a reverse chronological listing of the 10 latest posts @@ -39,6 +40,3 @@ tags: content_types | **keywords** | Optional | Synonyms and other keywords for the page. This information gets stuffed into the page's metadata to increase SEO. The user won't see the keywords, but if you search for one of the keywords, it will be picked up by the search engine. | | **summary** | Optional | A 1-2 word sentence summarizing the content on the page. This gets formatted into the summary section in the page layout. Adding summaries is a key way to make your content more scannable by users (check out [Jakob Nielsen's site](http://www.nngroup.com/articles/corporate-blogs-front-page-structure/) for a great example of page summaries.) The only drawback with summaries is that you can't use variables in them. | | **permalink**| Required | This theme uses permalinks to facilitate the linking. You specify the permalink want for the page, and the \_site output will put the page into the root directory when you publish. The page will appear inside a folder by the same name, with the actual page being index.html. Browsers will automatically show the index.html file inside of any folder, so permalinks avoid the .html extension with file names. Permalink names don't have to match your file names, but it might be easier to keep them in sync. | - - - diff --git a/mydoc/mydoc_publishing_github_pages.md b/mydoc/mydoc_publishing_github_pages.md index f8472da..ab3d9c3 100644 --- a/mydoc/mydoc_publishing_github_pages.md +++ b/mydoc/mydoc_publishing_github_pages.md @@ -3,6 +3,7 @@ title: Publishing on Github Pages sidebar: mydoc_sidebar permalink: /mydoc_publishing_github_pages/ summary: "You can publish your project on Github Pages, which is a free web hosting service provided by Github. All you need is to put your content into a Github repo branch called gh-pages and make this your default branch in your repo. With a Jekyll site, you just commit your entire project into the gh-pages branch and Github Pages will build the site for you." +folder: mydoc --- ## Set up your Github repo @@ -11,37 +12,37 @@ summary: "You can publish your project on Github Pages, which is a free web host 1. Go to [Github.com](http://github.com) and sign up for an account. 2. Click the **+** button in the upper-right corner and select **New repository**. 3. Name the repository something like **mydoctheme**. -4. Type a description.. +4. Type a description.. 5. Select the **Initialize this repository with a README** check box. 6. Add a license if desired. 7. Leave the other options at the defaults and click **Create repository**. -8. Click the **Settings** button. -9. Go to your repository's home page, and click the branch drop-down menu. +8. Click the **Settings** button. +9. Go to your repository's home page, and click the branch drop-down menu. 10. Create a new branch called **gh-pages**. 11. Click **Settings** and change the default branch to **gh-pages**. 11. Go back to your repository's homepage. With the gh-pages branch selected, copy the **https clone url**: 12. Open a terminal, browse to a convenient location for your project, and type `git clone https://github.com/tomjohnson1492/myreponame.git`, replacing the `https://github.com/tomjohnson1492/myreponame.git` with your repository's https clone URL that you copied. 13. Move the jekyll theme files into this new folder that you just created in the previous step. 14. Open the _config.yml file and add the following: - + ``` url: tomjohnson1492.github.io baseurl: /myreponame ``` - - Change the url to your github account name, and the baseurl to your repo name. + + Change the url to your github account name, and the baseurl to your repo name. ## Install Bundler Bundler is a package manager for Ruby that will install all dependencies you might need to build your site locally. I recommend installing Bundler through homebrew. (Sorry, these instructions apply to Mac only.) 1. Install [homebrew](http://brew.sh/): - + ``` /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" ``` 2. Install Bundler: - + ``` gem install bundler ``` @@ -49,16 +50,16 @@ Bundler is a package manager for Ruby that will install all dependencies you mig ## Add the github pages gem -1. In terminal, browse to your Jekyll project directory. +1. In terminal, browse to your Jekyll project directory. 2. Type `bundle init`. This creates a Gemfile and Gemfile.lock in your project. 3. Type `open gemfile`. This opens the gemfile in your default text editor. 4. Add the following in the gemfile (replacing the existing contents): - + ``` source 'https://rubygems.org' gem 'github-pages' ``` - + 5. Run `bundle install`. 14. Add the new jekyll files to git: `git add --all`. 15. Commit the files: `git commit -m "committing my jekyll theme"`. @@ -69,4 +70,3 @@ Github Pages will now automatically build your site. Wait a minute or two, and t ## Customize your URL You can also customize your Github URL. More instructions on this later.... - diff --git a/mydoc/mydoc_push_build_to_server.md b/mydoc/mydoc_push_build_to_server.md index 56375c7..49fd62e 100644 --- a/mydoc/mydoc_push_build_to_server.md +++ b/mydoc/mydoc_push_build_to_server.md @@ -6,6 +6,7 @@ last_updated: March 20, 2016 summary: "You can push your build to AWS using commands from the command line. By including your copy commands in commands, you can package all of the build and deploy process into executable scripts." sidebar: mydoc_sidebar permalink: /mydoc_push_build_to_server/ +folder: mydoc --- @@ -30,5 +31,3 @@ scp -r /users/tjohnson/projects/mydocproject/ name@domain:/var/www/html/mydocpro ``` Similar to the above, the first path is the local location; the second path is the destination. - - diff --git a/mydoc/mydoc_release_notes_50.md b/mydoc/mydoc_release_notes_50.md index cb61f4f..75ac1c5 100644 --- a/mydoc/mydoc_release_notes_50.md +++ b/mydoc/mydoc_release_notes_50.md @@ -6,13 +6,14 @@ last_updated: March 20, 2016 summary: "Version 5.0 of the Documentation theme for Jekyll changes some fundamental ways the theme works to provide product-specific sidebars, intended to accommodate a site where multiple products are grouped together on the same site rather than generated out as separate outputs." sidebar: mydoc_sidebar permalink: /mydoc_release_notes_50/ +folder: mydoc --- ## Unique sidebars for each product -In previous versions of the theme, I built the theme to generate different outputs for different scenarios based on various filtering attributes that might include product, version, platform, and audience variants. +In previous versions of the theme, I built the theme to generate different outputs for different scenarios based on various filtering attributes that might include product, version, platform, and audience variants. -However, this model results in siloed outputs and lots of separate file directories to manage. Instead of having 30 separate sites for your content (or however many variants you might have been producing), in this version of the theme I've moved towards a strategy of having one site with multiple products. +However, this model results in siloed outputs and lots of separate file directories to manage. Instead of having 30 separate sites for your content (or however many variants you might have been producing), in this version of the theme I've moved towards a strategy of having one site with multiple products. For each product, you can associate a unique sidebar with each of the product's pages. This allows you to have all your documentation on one site, but with separate navigation that is tailored to a view of that product. @@ -28,13 +29,13 @@ I also switched from redcarpet and Pygments to Kramdown and Rouge to align with ## Blog feature -I included a blog feature with this version of the theme. You can write posts and view them through the News link. There's also an archive for blog posts that sorts posts by year. +I included a blog feature with this version of the theme. You can write posts and view them through the News link. There's also an archive for blog posts that sorts posts by year. Additionally, the tagging system works across both the blog and pages, so your tags allow users to move laterally across the site based on topics they're interested in. When you view a tag archive, the sidebar shows a list of tags. ## Updated documentation -I updated the documentation for the theme. The switch from the multi-site outputs to the single-site with multiple sidebars required updating a lot of different parts of the documentation and code. +I updated the documentation for the theme. The switch from the multi-site outputs to the single-site with multiple sidebars required updating a lot of different parts of the documentation and code. ## Fixed errors @@ -42,4 +43,4 @@ Previously I had some errors with the HTML that showed up in w3c HTML validator ## Accessing the old theme -If you want to access the old theme, you can still find it [here](https://github.com/tomjohnson1492/jekylldoctheme-separate-outputs). \ No newline at end of file +If you want to access the old theme, you can still find it [here](https://github.com/tomjohnson1492/jekylldoctheme-separate-outputs). diff --git a/mydoc/mydoc_search_configuration.md b/mydoc/mydoc_search_configuration.md index adfe42c..cb51629 100644 --- a/mydoc/mydoc_search_configuration.md +++ b/mydoc/mydoc_search_configuration.md @@ -6,6 +6,7 @@ last_updated: March 20, 2016 summary: "The search feature uses JavaScript to look for keyword matches in a JSON file. The results show instant matches, but it doesn't provide a search results page like Google. Also, sometimes invalid formatting can break the JSON file." sidebar: mydoc_sidebar permalink: /mydoc_search_configuration/ +folder: mydoc --- ## About search @@ -27,9 +28,9 @@ If any formatting in the search.json file is invalid (in the build), search won' If this happens, go directly to the search.json file in your browser, and then copy the content. Go to a [JSON validator](http://jsonlint.com/) and paste in the content. Look for the line causing trouble. Edit the file to either exclude the page from search or fix the syntax so that it doesn't invalidate the JSON. (Note that tabs in the body will invalidate JSON.) -The search.json file already tries to strip out content that would otherwise make the JSON invalid. +The search.json file already tries to strip out content that would otherwise make the JSON invalid. -## Including the body field in search +## Including the body field in search I've found that include the `body` field in the search creates too many problems, and so I've removed `body` from the search. You can see the results of including the `body` by adding this along with the other fields in search.json: {% raw %} @@ -108,8 +109,8 @@ The \_includes/topnav.html file then makes use of these values: ``` -Where you see `{url}` and `{title}`, the search is retrieving the values for these as specified in the search.json file. +Where you see `{url}` and `{title}`, the search is retrieving the values for these as specified in the search.json file. ## More robust search -For more robust search, consider integrating either [Algolia](http://algolia.com) or [Swifttype](http://swiftype.com). \ No newline at end of file +For more robust search, consider integrating either [Algolia](http://algolia.com) or [Swifttype](http://swiftype.com). diff --git a/mydoc/mydoc_series.md b/mydoc/mydoc_series.md index 5b97537..7e6d465 100644 --- a/mydoc/mydoc_series.md +++ b/mydoc/mydoc_series.md @@ -6,13 +6,14 @@ last_updated: March 20, 2016 summary: "You can automatically link together topics belonging to the same series. This helps users know the context within a particular process." sidebar: mydoc_sidebar permalink: /mydoc_series/ +folder: mydoc --- ## Using series for pages You create a series by looking for all pages within a tag namespace that contain certain frontmatter. Here's a demo. -## 1. Create the series button +## 1. Create the series button First create an include that contains your series button: @@ -40,7 +41,7 @@ First create an include that contains your series button: ``` {% endraw %} -Change "ACME series" to the name of your series. +Change "ACME series" to the name of your series. Save this in your \_includes/custom folder as something like series\_acme.html. @@ -48,7 +49,7 @@ Save this in your \_includes/custom folder as something like series\_acme.html. ## 2. Create the "next" include -Now create another include for the Next button at the bottom of the page. Copy the following code, changing the series name to your series'name: +Now create another include for the Next button at the bottom of the page. Copy the following code, changing the series name to your series'name: {% raw %} ```html @@ -65,9 +66,9 @@ Now create another include for the Next button at the bottom of the page. Copy t ``` {% endraw %} -Change "acme" to the name of your series. +Change "acme" to the name of your series. -Save this in your \_includes/custom/mydoc folder as series\_acme\_next.html. +Save this in your \_includes/custom/mydoc folder as series\_acme\_next.html. ## 3. Add the correct frontmatter to each of your series pages @@ -85,7 +86,7 @@ Additionally, if your page names are prefaced with numbers, such as "1. Download ## 4. Add links to the series button and next button on each page. On each series page, add a link to the series button at the top and a link to the next button at the bottom. - + {% raw %} ```liquid @@ -104,4 +105,4 @@ The Bootstrap menu uses the `primary` class for styling. If you change this clas ## Using a collection with your series -Instead of copying and pasting the button includes on each of your series, you could also create a collection and define a layout for the collection that has the include code. For more information on creating collections, see Collections. \ No newline at end of file +Instead of copying and pasting the button includes on each of your series, you could also create a collection and define a layout for the collection that has the include code. For more information on creating collections, see Collections. diff --git a/mydoc/mydoc_seriesdemo1.md b/mydoc/mydoc_seriesdemo1.md index 15a84ec..fc2cb83 100644 --- a/mydoc/mydoc_seriesdemo1.md +++ b/mydoc/mydoc_seriesdemo1.md @@ -6,6 +6,7 @@ weight: 1 last_updated: March 20, 2016 sidebar: mydoc_sidebar permalink: /mydoc_seriesdemo1/ +folder: mydoc --- {% include custom/series_acme.html %} @@ -17,5 +18,3 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudi Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. Mauris consequat accumsan ex, a iaculis metus fermentum a. Praesent sit amet fermentum leo. Aliquam feugiat, nibh in ultrices mattis, felis ipsum venenatis metus, vel vehicula libero mauris a enim. Sed placerat est ac lectus vestibulum tempor. Quisque ut condimentum massa. Proin venenatis leo id urna cursus blandit. Vivamus sit amet hendrerit metus. {% include custom/series_acme_next.html %} - - diff --git a/mydoc/mydoc_seriesdemo2.md b/mydoc/mydoc_seriesdemo2.md index 67a0800..e823de6 100644 --- a/mydoc/mydoc_seriesdemo2.md +++ b/mydoc/mydoc_seriesdemo2.md @@ -6,6 +6,7 @@ weight: 2 last_updated: March 20, 2016 sidebar: mydoc_sidebar permalink: /mydoc_seriesdemo2/ +folder: mydoc --- @@ -17,6 +18,6 @@ Aliquam feugiat, nibh in ultrices mattis, felis ipsum venenatis metus, vel vehic Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. Mauris consequat accumsan ex, a iaculis metus fermentum a. Praesent sit amet fermentum leo. Aliquam feugiat, nibh in ultrices mattis, felis ipsum venenatis metus, vel vehicula libero mauris a enim. Sed placerat est ac lectus vestibulum tempor. Quisque ut condimentum massa. Proin venenatis leo id urna cursus blandit. Vivamus sit amet hendrerit metus. -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. Mauris consequat accumsan ex, a iaculis metus fermentum a. Praesent sit amet fermentum leo. +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. Mauris consequat accumsan ex, a iaculis metus fermentum a. Praesent sit amet fermentum leo. -{% include custom/series_acme_next.html %} \ No newline at end of file +{% include custom/series_acme_next.html %} diff --git a/mydoc/mydoc_seriesdemo3.md b/mydoc/mydoc_seriesdemo3.md index 2fc54e8..cab42e6 100644 --- a/mydoc/mydoc_seriesdemo3.md +++ b/mydoc/mydoc_seriesdemo3.md @@ -7,6 +7,7 @@ weight: 3 last_updated: March 20, 2016 sidebar: mydoc_sidebar permalink: /mydoc_seriesdemo3/ +folder: mydoc --- {% include custom/series_acme.html %} @@ -15,7 +16,7 @@ This is the third post in the series. Mauris consequat accumsan ex, a iaculis metus fermentum a. Praesent sit amet fermentum leo. Aliquam feugiat, nibh in ultrices mattis, felis ipsum venenatis metus, vel vehicula libero mauris a enim. Sed placerat est ac lectus vestibulum tempor. Quisque ut condimentum massa. Proin venenatis leo id urna cursus blandit. Vivamus sit amet hendrerit metus. -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. Mauris consequat accumsan ex, a iaculis metus fermentum a. Praesent sit amet fermentum leo. Aliquam feugiat, nibh in ultrices mattis, felis ipsum venenatis metus, vel vehicula libero mauris a enim. Sed placerat est ac lectus vestibulum tempor. Quisque ut condimentum massa. Proin venenatis leo id urna cursus blandit. Vivamus sit amet hendrerit metus. diff --git a/mydoc/mydoc_seriesdemo4.md b/mydoc/mydoc_seriesdemo4.md index d882b73..6d1bb39 100644 --- a/mydoc/mydoc_seriesdemo4.md +++ b/mydoc/mydoc_seriesdemo4.md @@ -6,6 +6,7 @@ weight: 4 last_updated: March 20, 2016 sidebar: mydoc_sidebar permalink: /mydoc_seriesdemo4/ +folder: mydoc --- @@ -20,7 +21,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudi Mauris consequat accumsan ex, a iaculis metus fermentum a. Praesent sit amet fermentum leo. Aliquam feugiat, nibh in ultrices mattis, felis ipsum venenatis metus, vel vehicula libero mauris a enim. Sed placerat est ac lectus vestibulum tempor. Quisque ut condimentum massa. Proin venenatis leo id urna cursus blandit. Vivamus sit amet hendrerit metus. -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel sollicitudin felis. Sed eu arcu sed ipsum semper luctus eu a tortor. Suspendisse id leo eu metus laoreet varius. {% include custom/series_acme_next.html %} diff --git a/mydoc/mydoc_sidebar_navigation.md b/mydoc/mydoc_sidebar_navigation.md index 3d44d86..48dd0a3 100644 --- a/mydoc/mydoc_sidebar_navigation.md +++ b/mydoc/mydoc_sidebar_navigation.md @@ -6,6 +6,7 @@ keywords: sidebar, accordion, yaml, iteration, for loop, navigation, attributes, summary: "The sidebar navigation uses a jQuery component called Navgoco. The sidebar is a somewhat complex part of the theme that remembers your current page, highlights the active item, stays in a fixed position on the page, and more. This page explains a bit about how the sidebar was put together." sidebar: mydoc_sidebar permalink: /mydoc_sidebar_navigation/ +folder: mydoc --- ## Navgoco foundation @@ -20,11 +21,11 @@ In short, the sidebar has some complex logic here. I've integrated Navgoco's fea ## Accordion sidebar feature -The sidebar.html file (inside the _includes folder) contains the `.navgoco` method called on the `#mysidebar` element. +The sidebar.html file (inside the _includes folder) contains the `.navgoco` method called on the `#mysidebar` element. -There are some options to set within the `.navgoco` method. The only noteworthy option is `accordion`. This option makes it so when you expand a section, the other sections collapse. It's a way of keeping your navigation controls condensed. +There are some options to set within the `.navgoco` method. The only noteworthy option is `accordion`. This option makes it so when you expand a section, the other sections collapse. It's a way of keeping your navigation controls condensed. -The value for `accordion` is a Boolean (`true` or `false`). By default, the `accordion` option is set as `true`. If you don't want the accordion, set it to `false`. Note that there's also a block of code near the bottom of sidebar.html that is commented out. Uncomment out that section to have the Collapse all and Expand All buttons appear. +The value for `accordion` is a Boolean (`true` or `false`). By default, the `accordion` option is set as `true`. If you don't want the accordion, set it to `false`. Note that there's also a block of code near the bottom of sidebar.html that is commented out. Uncomment out that section to have the Collapse all and Expand All buttons appear. There's a danger with setting the accordion to `false`. If you click Expand All and the sidebar expands beyond the dimensions of the browser, users will be stuck. When that happens, it's hard to collapse it. As a best practice, leave the sidebar's accordion option set to `true`. @@ -38,7 +39,7 @@ Depending on your content, you may need to adjust `800` pixel number. If your si ## Opening sidebar links into external pages -In the attributes for each sidebar item, if you use `external_url` instead of `url`, the theme will insert the link into an `a href` element that opens in a blank target. +In the attributes for each sidebar item, if you use `external_url` instead of `url`, the theme will insert the link into an `a href` element that opens in a blank target. For example, the sidebar.html file contains the following code: @@ -49,11 +50,11 @@ For example, the sidebar.html file contains the following code: ``` {% endraw %} -You can see that the `external_url` is a condition that applies a different formatting. Although this feature is available, I recommend putting any external navigation links in the top navigation bar instead of the side navigation bar. +You can see that the `external_url` is a condition that applies a different formatting. Although this feature is available, I recommend putting any external navigation links in the top navigation bar instead of the side navigation bar. ## Sidebar item highlighting -The sidebar.html file inserts an `active` class into the sidebar element when the `url` attribute in the sidebar data file matches the page URL. +The sidebar.html file inserts an `active` class into the sidebar element when the `url` attribute in the sidebar data file matches the page URL. For example, the sidebar.html file contains the following code: @@ -64,15 +65,15 @@ For example, the sidebar.html file contains the following code: ``` {% endraw %} -If the `page.url` matches the `subfolderitem.url`, then an `active` class gets applied. If not, the `active` class does not get applied. +If the `page.url` matches the `subfolderitem.url`, then an `active` class gets applied. If not, the `active` class does not get applied. -The `page.url` in Jekyll is a site-wide variable. If you insert {% raw %}`{{page.url}}`{% endraw %} on a page, it will render as follows: {{page.url}}. The `url` attribute in the sidebar item must match the page URL in order to get the `active` class applied. +The `page.url` in Jekyll is a site-wide variable. If you insert {% raw %}`{{page.url}}`{% endraw %} on a page, it will render as follows: {{page.url}}. The `url` attribute in the sidebar item must match the page URL in order to get the `active` class applied. This is why the `url` value in the sidebar data file looks something like this: ```yaml - title: Understanding how the sidebar works - url: /mydoc_understand_sidebar/ + url: /mydoc_understand_sidebar/ output: web, pdf ``` diff --git a/mydoc/mydoc_special_layouts.md b/mydoc/mydoc_special_layouts.md index 5c3c849..7de0443 100644 --- a/mydoc/mydoc_special_layouts.md +++ b/mydoc/mydoc_special_layouts.md @@ -6,6 +6,7 @@ last_updated: March 20, 2016 summary: "This theme has a few special layouts. Special layouts include the JS files they need directly in the page. The JavaScript for each special layout does not load by default for every page in the site." sidebar: mydoc_sidebar permalink: /mydoc_special_layouts/ +folder: mydoc --- @@ -26,5 +27,3 @@ If you have a long JSON message you're documenting, see the {{site.data.mydoc_ur ## Shuffle layout If you want a dynamic card layout that allows you to filter the cards, see {{site.data.mydoc_urls.mydoc_shuffle.link}}. This uses the Shuffle JS library. - - diff --git a/mydoc/mydoc_support.md b/mydoc/mydoc_support.md index 7945842..e87edb3 100644 --- a/mydoc/mydoc_support.md +++ b/mydoc/mydoc_support.md @@ -6,6 +6,7 @@ last_updated: March 20, 2016 summary: "Contact me for any support issues." sidebar: mydoc_sidebar permalink: /mydoc_support/ +folder: mydoc --- -Let me know about any bugs or other issues that you find. Just email me at tomjohnson1492@gmail.com. You can also [create issues directly within the Github repository here](https://github.com/tomjohnson1492/jekyll-doc/issues). \ No newline at end of file +Let me know about any bugs or other issues that you find. Just email me at tomjohnson1492@gmail.com. You can also [create issues directly within the Github repository here](https://github.com/tomjohnson1492/jekyll-doc/issues). diff --git a/mydoc/mydoc_supported_features.md b/mydoc/mydoc_supported_features.md index 9d3545b..b82b1ed 100644 --- a/mydoc/mydoc_supported_features.md +++ b/mydoc/mydoc_supported_features.md @@ -1,6 +1,6 @@ --- title: Supported features -tags: +tags: - getting_started keywords: "features, capabilities, scalability, multichannel output, dita, hats, comparison, benefits" last_updated: "November 30, 2016" @@ -8,6 +8,7 @@ summary: "If you're not sure whether Jekyll and this theme will support your req published: true sidebar: mydoc_sidebar permalink: /mydoc_supported_features/ +folder: mydoc --- Before you get into exploring Jekyll as a potential platform for help content, you may be wondering if it supports some basic features needed to fulfill your tech doc requirements. The following table shows what is supported in Jekyll and this theme. @@ -18,12 +19,12 @@ Features | Supported | Notes --------|-----------|----------- Content re-use | Yes | Supports re-use through Liquid. You can re-use variables, snippets of code, entire pages, and more. In DITA speak, this includes conref and keyref. Markdown | Yes | You can author content using Markdown syntax. This is a wiki-like syntax for HTML that you can probably pick up in 10 minutes. Where Markdown falls short, you can use HTML. Where HTML falls short, you use Liquid, which is a scripting that allows you to incorporate more advanced logic. -Responsive design | Yes | Uses Bootstrap framework for responsive design. +Responsive design | Yes | Uses Bootstrap framework for responsive design. Translation | Yes | I haven't done a translation project yet (just a pilot test). Here's the basic approach: Export the HTML pages and send them to a translation agency. Then create a new project for that language and insert the translated pages. Everything will be translated. -Collaboration | Yes | You collaborate with Jekyll projects the same way that developers collaborate with software projects. (You don't need a CMS.) Because you're working with text file formats, you can use any version control software (Git, Mercurial, Perforce, Bitbucket, etc.) as a CMS for your files. +Collaboration | Yes | You collaborate with Jekyll projects the same way that developers collaborate with software projects. (You don't need a CMS.) Because you're working with text file formats, you can use any version control software (Git, Mercurial, Perforce, Bitbucket, etc.) as a CMS for your files. Scalability | Yes | Your site can scale to any size. It's up to you to determine how you will design the information architecture for your thousands of pages. You can choose what you display at first, second, third, fourth, and more levels, etc. Note that when your project has thousands of pages, the build time will be longer (maybe 1 minute per thousand pages?). It really depends on how many for loops you have iterating through the pages. Lightweight architecture | Yes | You don't need a LAMP stack (Linux, Apache, MySQL, PHP) architecture to get your site running. All of the building is done on your own machine, and you then push the static HTML files onto a server. -Skinnability | Yes | You can skin your Jekyll site to look identical to pretty much any other site online. If you have a UX team, they can really skin and design the site using all the tools familiar to the modern designer -- JavaScript, HTML5, CSS, jQuery, and more. Jekyll is built on the modern web development stack rather than the XML stack (XSLT, XPath, XQuery). +Skinnability | Yes | You can skin your Jekyll site to look identical to pretty much any other site online. If you have a UX team, they can really skin and design the site using all the tools familiar to the modern designer -- JavaScript, HTML5, CSS, jQuery, and more. Jekyll is built on the modern web development stack rather than the XML stack (XSLT, XPath, XQuery). Support | Yes | The community for your Jekyll site isn't so much other tech writers (as is the case with DITA) but rather the wider web development community. [Jekyll Talk](http://talk.jekyllrb.com) is a great resource. So is Stack Overflow. Blogging features | Yes | There is a simple blogging feature. This appears as "news" and is intended to promote news that applies across products. Versioning | Yes | Jekyll doesn't version your files. You upload your files to a version control system such as Github. Your files are versioned there. @@ -37,7 +38,7 @@ Open source | Yes | This theme is entirely open source. Every piece of code is o ## Features not available -The following features are not available. +The following features are not available. Features | Supported | Notes --------|-----------|----------- @@ -49,5 +50,3 @@ Standardized templates | No | You can create pages with any structure you want. Integration with Swagger | No | You can link to a SwaggerUI output, but there is no built-in integration of SwaggerUI into this documentation theme. Templates for endpoints | No | Although static site generators work well with API documentation, there aren't any built-in templates specific to endpoints in this theme. You could construct your own, though. eBook output | No | There isn't an eBook output for the content. - - diff --git a/mydoc/mydoc_syntax_highlighting.md b/mydoc/mydoc_syntax_highlighting.md index 9163928..6ea80af 100644 --- a/mydoc/mydoc_syntax_highlighting.md +++ b/mydoc/mydoc_syntax_highlighting.md @@ -6,6 +6,7 @@ last_updated: March 20, 2016 summary: "You can apply syntax highlighting to your code. This theme uses pygments and applies color coding based on the lexer you specify." sidebar: mydoc_sidebar permalink: /mydoc_syntax_highlighting/ +folder: mydoc --- ## About syntax highlighting @@ -41,7 +42,7 @@ If you're using an HTML file, you can also use the `highlight` command with Liqu {% endraw %} -It renders the same: +It renders the same: {% highlight ruby %} def foo @@ -73,4 +74,3 @@ The keywords you must add to specify the highlighting (in the previous example, * dotnet * xml * http - diff --git a/mydoc/mydoc_tables.md b/mydoc/mydoc_tables.md index 2da273a..b7876f3 100644 --- a/mydoc/mydoc_tables.md +++ b/mydoc/mydoc_tables.md @@ -7,6 +7,7 @@ datatable: true summary: "You can format tables using either multimarkdown syntax or HTML. You can also use jQuery datatables (a plugin) if you need more robust tables." sidebar: mydoc_sidebar permalink: /mydoc_tables/ +folder: mydoc --- {% unless site.output == "pdf" %} @@ -25,7 +26,7 @@ $(document).ready(function(){ ## Multimarkdown Tables -You can use Multimarkdown syntax for tables. The following shows a sample: +You can use Multimarkdown syntax for tables. The following shows a sample: ``` Column 1 | Column 2 @@ -65,7 +66,7 @@ The available options for the datable are described in the [datatable documentat Additionally, you must add a class of `display` to your tables. (You can change the class, but then you'll need to change the trigger above from `table.display` to whatever class you want to you. You might have different triggers with different options for different tables.) -Since Markdown doesn't allow you to add classes to tables, you'll need to use HTML for any datatables. Here's an example: +Since Markdown doesn't allow you to add classes to tables, you'll need to use HTML for any datatables. Here's an example: ```html @@ -124,7 +125,7 @@ This renders to the following: - @@ -161,4 +162,4 @@ Notice a few features: Read more of the [datatable documentation](https://www.datatables.net/manual/options) to get a sense of the options you can configure. You should probably only use datatables when you have long, massive tables full of information. -{{site.data.alerts.note}} Try to keep the columns to 3 or 4 columns only. If you add 5+ columns, your table may create horizontal scrolling with the theme. Additionally, keep the column heading titles short.{{site.data.alerts.end}} \ No newline at end of file +{{site.data.alerts.note}} Try to keep the columns to 3 or 4 columns only. If you add 5+ columns, your table may create horizontal scrolling with the theme. Additionally, keep the column heading titles short.{{site.data.alerts.end}} diff --git a/mydoc/mydoc_tag_archives_overview.md b/mydoc/mydoc_tag_archives_overview.md index e7ba987..e5143d0 100644 --- a/mydoc/mydoc_tag_archives_overview.md +++ b/mydoc/mydoc_tag_archives_overview.md @@ -6,6 +6,7 @@ tags: [navigation] summary: "This is an overview to the tag archives section. Really the only reason this section is listed explicitly in the TOC here is to demonstrate how to add a third-level to the navigation." sidebar: mydoc_sidebar permalink: /mydoc_tag_archives_overview/ +folder: mydoc --- ## Reasons for tags diff --git a/mydoc/mydoc_tags.md b/mydoc/mydoc_tags.md index 4e50c4d..c3c554e 100644 --- a/mydoc/mydoc_tags.md +++ b/mydoc/mydoc_tags.md @@ -7,6 +7,7 @@ keywords: tags, navigation, buttons, links, association summary: "Tags provide another means of navigation for your content. Unlike the table of contents, tags can show the content in a variety of arrangements and groupings. Implementing tags in this Jekyll theme is somewhat of a manual process." sidebar: mydoc_sidebar permalink: /mydoc_tags/ +folder: mydoc --- @@ -41,7 +42,7 @@ For simplicity, make all your tags single words (connect them with hyphens if ne Tags have a few components. 1. In the \_data/tags.yml file, add the tag names you want to allow. For example: - + ```json allowed-tags: - getting_started @@ -52,11 +53,11 @@ Tags have a few components. - special_layouts - content types ``` - -3. Create a tag archive file for each tag in your tags_doc.yml list. Name the file following the same pattern in the tags folder, like this: tag_collaboration.html. - + +3. Create a tag archive file for each tag in your tags_doc.yml list. Name the file following the same pattern in the tags folder, like this: tag_collaboration.html. + Each tag archive file needs only this: - + {% raw %} ```liquid --- @@ -71,9 +72,9 @@ sidebar: tags_sidebar {% endraw %} {{site.data.alerts.note}}In the \_includes/mydoc folder, there's a taglogic.html file. This file (included in each tag archive file) has common logic for getting the tags and listing out the pages containing the tag in a table with summaries or truncated excerpts. You don't have to do anything with the file — just leave it there because the tag archive pages reference it.{{site.data.alerts.end}} - + 4. Change the title, tagName, and permalink values to be specific to the tag name you just created. - + By default, the \_layouts/page.html file will look for any tags on a page and insert them at the bottom of the page using this code: {% raw %} @@ -91,9 +92,9 @@ sidebar: tags_sidebar ``` {% endraw %} - + Because this code appears on the \_layouts/page.html file by default, you don't need to do anything in your page to get the tags to appear. However, if you want to alter the placement or change the button color, you can do so within the \_includes/taglogic.html file. - + You can change the button color by changing the class on the button from `btn-info` to one of the other button classes bootstrap provides. See page for more options on button class names. ## Retrieving pages for a specific tag @@ -102,7 +103,7 @@ If you want to retrieve pages outside of a particular tag_archive page, you coul {% raw %} ```liquid -Getting started pages: +Getting started pages:
      {% for page in site.pages %} {% for tag in page.tags %} @@ -110,12 +111,12 @@ Getting started pages:
    • {{page.title}}
      • {% endif %} {% endfor %} -{% endfor %} +{% endfor %}
    ``` {% endraw %} -Here's how that code renders: +Here's how that code renders: Getting started pages:
      @@ -141,7 +142,7 @@ Getting started pages:
    • {{page.title}}
      • {% endif %} {% endfor %} -{% endfor %} +{% endfor %}
    {% endraw %} ``` @@ -161,11 +162,11 @@ Getting started pages: ## Efficiency -Although the tag approach here uses `for` loops, these are somewhat inefficient on a large site. Most of my tech doc projects don't have hundreds of pages (like my blog does). If your project does have hundreds of pages, this `for` loop approach with tags is going to slow down your build times. +Although the tag approach here uses `for` loops, these are somewhat inefficient on a large site. Most of my tech doc projects don't have hundreds of pages (like my blog does). If your project does have hundreds of pages, this `for` loop approach with tags is going to slow down your build times. -Without the ability to access pages inside a universal namespace with the page type, there aren't many workarounds here for faster looping. +Without the ability to access pages inside a universal namespace with the page type, there aren't many workarounds here for faster looping. -With posts (instead of pages), since you can access just the posts inside `posts.tag.tagname`, you can be a lot more efficient with the looping. +With posts (instead of pages), since you can access just the posts inside `posts.tag.tagname`, you can be a lot more efficient with the looping. Still, if the build times are getting long (e.g., 1 or 2 minutes per build), look into reducing the number of `for` loops on your site. @@ -180,7 +181,6 @@ If you don't want tags to appear at all on your page, remove the tags property f ## Remembering the right tags -Since you may have many tags and find it difficult to remember what tags are allowed, I recommend creating a template that prepopulates all your frontmatter with all possible tags. Then just remove the tags that don't apply. +Since you may have many tags and find it difficult to remember what tags are allowed, I recommend creating a template that prepopulates all your frontmatter with all possible tags. Then just remove the tags that don't apply. See WebStorm Text Editor for tips on creating file templates in WebStorm. - diff --git a/mydoc/mydoc_themes.md b/mydoc/mydoc_themes.md index 54a04a3..6228951 100644 --- a/mydoc/mydoc_themes.md +++ b/mydoc/mydoc_themes.md @@ -6,6 +6,7 @@ last_updated: March 20, 2016 summary: "You can choose between two different themes (one green, the other blue) for your projects. The theme CSS is stored in the CSS folder and configured in the configuration file for each project." sidebar: mydoc_sidebar permalink: /mydoc_themes/ +folder: mydoc --- @@ -19,6 +20,6 @@ In the \_includes/head.html file, specify the theme file you want the output to ``` ## Theme differences -The differences between the themes is fairly minimal. The main navigation bar, sidebar, buttons, and heading colors change color. That's about it. +The differences between the themes is fairly minimal. The main navigation bar, sidebar, buttons, and heading colors change color. That's about it. In a more sophisticated theming approach, you could use Sass files to generate rules based on options set in a data file, but I kept things simple here. diff --git a/mydoc/mydoc_title_checker.md b/mydoc/mydoc_title_checker.md index b7c0432..ab393ec 100644 --- a/mydoc/mydoc_title_checker.md +++ b/mydoc/mydoc_title_checker.md @@ -6,6 +6,7 @@ last_updated: "November 30, 2016" summary: "The title checker page helps ensure that the titles in your pages match the titles in your TOC." sidebar: mydoc_sidebar permalink: /mydoc_title_checker/ +folder: mydoc --- The theme has a file called title-checker.html. This file will iterate through all the pages listed in the sidebar navigation and top navigation, and compare the navigation titles against the page titles based on matching URLs. If there are inconsistencies in the titles, they get noted on the title-checker.html page. @@ -17,4 +18,3 @@ Note that in order for the title-checker file to run correctly, it has to detect {{site.data.alerts.note}} If your page titles have your product name in parentheses, but your sidebar doesn't have the product name in parentheses, this title-checker tool is going to return a lot of mismatches. This is one limitation of the code right now. {{site.data.alerts.end}} Note also that you must manually configure your sidebar file in the first line of the code, and then repeat the same chunk of code for each sidebar. Right now the code doesn't automatically iterate over every sidebar file. It's somewhat of a manual configuration process there. - diff --git a/mydoc/mydoc_troubleshooting.md b/mydoc/mydoc_troubleshooting.md index f7da4a2..0bfe0d9 100644 --- a/mydoc/mydoc_troubleshooting.md +++ b/mydoc/mydoc_troubleshooting.md @@ -6,13 +6,14 @@ last_updated: March 20, 2016 summary: "This page lists common errors and the steps needed to troubleshoot them." sidebar: mydoc_sidebar permalink: /mydoc_troubleshooting/ +folder: mydoc --- ## Issues building the site ### Address already in use -When you try to build the site, you get this error in iTerm: +When you try to build the site, you get this error in iTerm: ``` jekyll 2.5.3 | Error: Address already in use - bind(2) @@ -36,7 +37,7 @@ kill -9 $(ps aux | grep '[j]ekyll' | awk '{print $2}') ### shell file not executable If you run into permissions errors trying to run a shell script file (such as mydoc_multibuild_web.sh), you may need to change the file permissions to make the sh file executable. Browse to the directory containing the shell script and run the following: - + ``` chmod +x build_writer.sh ``` @@ -47,17 +48,17 @@ If you're using a PC, rename your shell files with a .bat extension. ### "page 0" cross references in the PDF -If you see "page 0" cross-references in the PDF, the URL doesn't exist. Check to make sure you actually included this page in the build. +If you see "page 0" cross-references in the PDF, the URL doesn't exist. Check to make sure you actually included this page in the build. If it's not a page but rather a file, you need to add a `noCrossRef` class to the file so that your print stylesheet excludes the counter from it. Add `class="noCrossRef"` as an attribute to the link. In the css/printstyles.css file, there is a style that should remove the counter from anchor elements with this class. - + ### The PDF is blank - + Check the prince-list.txt file in the output to see if it contains links. If not, you have something wrong with the logic in the prince-list.txt file. Check the conditions.html file in your \_includes to see if the audience specified in your configuration file aligns with the buildAudience in the conditions.html file ### Sidebar not appearing -If you build your site but the sidebar doesn't appear, check the following: +If you build your site but the sidebar doesn't appear, check the following: Look in \_includes/custom/sidebarconfigs.html and make sure the conditional values there match up with values you're using in each page's frontmatter. @@ -67,12 +68,8 @@ Understanding how the theme works can be helpful in troubleshooting. The \_inclu ### Sidebar isn't collapsed -If the sidebar levels aren't collapsed, usually your JavaScript is broken somewhere. Open the JavaScript Console and look to see where the problem is. If one script breaks, then other scripts will break too, so troubleshooting it is a little tricky. +If the sidebar levels aren't collapsed, usually your JavaScript is broken somewhere. Open the JavaScript Console and look to see where the problem is. If one script breaks, then other scripts will break too, so troubleshooting it is a little tricky. ### Search isn't working If the search isn't working, check the JSON validity in the search.json file in your output folder. Usually something is invalid. Identify the problematic line, fix the file, or put `search: exclude` in the frontmatter of the file to exclude it from search. - - - - diff --git a/mydoc/mydoc_webstorm_text_editor.md b/mydoc/mydoc_webstorm_text_editor.md index 662824e..cf331bf 100644 --- a/mydoc/mydoc_webstorm_text_editor.md +++ b/mydoc/mydoc_webstorm_text_editor.md @@ -5,6 +5,7 @@ last_updated: March 20, 2016 summary: "You can use a variety of text editors when working with a Jekyll project. WebStorm from IntelliJ offers a lot of project-specific features, such as find and replace, that make it ideal for working with tech comm projects." sidebar: mydoc_sidebar permalink: /mydoc_webstorm_text_editor/ +folder: mydoc --- ## About text editors and WebStorm @@ -20,7 +21,7 @@ By default, WebStorm comes packaged with a lot more functionality than you proba You can set the way the tab works, and whether it uses spaces or a tab character. For details, see [Code Style. JavaScript](https://www.jetbrains.com/help/webstorm/2016.1/code-style-javascript.html?origin=old_help#d658997e132) in WebStorm's help. -On a Mac, go to **WebStorm | Preferences | Editor | Code Style | Other File Types**. Don't select the "Use tab character" check box. Set **3** for the **Tab size** and **Indent** check boxes. +On a Mac, go to **WebStorm | Preferences | Editor | Code Style | Other File Types**. Don't select the "Use tab character" check box. Set **3** for the **Tab size** and **Indent** check boxes. On Windows, go to **File | Settings | Editor | Code Style | Other File Types** to access the same menu. @@ -38,7 +39,7 @@ When you're searching for content, you don't want to edit any file that appears ## Set tabs to 3 spaces -You can set the default number of spaces a tab sets, including whether Webstorm uses a tab character or spaces. You want spaces, and you want to set this to default number of spaces to ```3``` spaces instead of 4. Note that this is due to the way Kramdown handles the continuation of lists. +You can set the default number of spaces a tab sets, including whether Webstorm uses a tab character or spaces. You want spaces, and you want to set this to default number of spaces to ```3``` spaces instead of 4. Note that this is due to the way Kramdown handles the continuation of lists. When you intercept a list with a paragraph or code sample, the indentation of the intercepting paragraph or list must align with the beginning of the first character after the space in the list item numbering. This is typically 3 spaces, not 4. Note that this style differs from the Github-flavored Markdown style. (Welcome to the world of subtle and infuriating discrepancies between Markdown flavors.) diff --git a/mydoc/mydoc_yaml_tutorial.md b/mydoc/mydoc_yaml_tutorial.md index 2ca49db..9b12d32 100644 --- a/mydoc/mydoc_yaml_tutorial.md +++ b/mydoc/mydoc_yaml_tutorial.md @@ -5,6 +5,7 @@ keywords: search summary: "YAML is a format that relies on white spacing to separate out the various elements of content. Jekyll lets you use Liquid with YAML as a way to parse through the data. Storing items for your table of contents is one of the most common uses of YAML with Jekyll." sidebar: mydoc_sidebar permalink: /mydoc_yaml_tutorial/ +folder: mydoc --- ## Overview One of the most interesting features of Jekyll is the ability to separate out data elements from formatting elements using a combination of YAML and Liquid. This setup is most common when you're trying to create a table of contents. diff --git a/news/news.html b/news/news.html index 638b8cc..281fd3a 100644 --- a/news/news.html +++ b/news/news.html @@ -4,6 +4,7 @@ sidebar: home_sidebar keywords: news, blog, updates, release notes, announcements permalink: /news/ toc: false +folder: news ---
    diff --git a/news/news_archive.html b/news/news_archive.html index 04b8d99..2d1bcc1 100644 --- a/news/news_archive.html +++ b/news/news_archive.html @@ -4,6 +4,7 @@ sidebar: tags_sidebar keywords: news, blog, updates, release notes, announcements permalink: /news_archive/ toc: false +folder: news ---
    diff --git a/product1/p1_landing_page.html b/product1/p1_landing_page.html index 22ab607..8ce1e56 100644 --- a/product1/p1_landing_page.html +++ b/product1/p1_landing_page.html @@ -4,6 +4,7 @@ keywords: mydoc sidebar: product1_sidebar toc: false permalink: /p1_landing_page/ +folder: product1 ---
    @@ -235,4 +236,4 @@ permalink: /p1_landing_page/
    -
    \ No newline at end of file + diff --git a/product1/p1_sample1.md b/product1/p1_sample1.md index f25fd14..a22d2a2 100644 --- a/product1/p1_sample1.md +++ b/product1/p1_sample1.md @@ -4,6 +4,7 @@ keywords: sample summary: "This is just a sample topic..." sidebar: product1_sidebar permalink: /p1_sample1/ +folder: product1 --- ## Sample Content @@ -13,11 +14,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product1/p1_sample2.md b/product1/p1_sample2.md index 17ec9cc..d15448f 100644 --- a/product1/p1_sample2.md +++ b/product1/p1_sample2.md @@ -4,6 +4,7 @@ keywords: sample summary: "This is just a sample topic..." sidebar: product1_sidebar permalink: /p1_sample2/ +folder: product1 --- ## Sample Content @@ -13,11 +14,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product1/p1_sample3.md b/product1/p1_sample3.md index d15da81..f54b457 100644 --- a/product1/p1_sample3.md +++ b/product1/p1_sample3.md @@ -4,6 +4,7 @@ keywords: sample summary: "This is just a sample topic..." sidebar: product1_sidebar permalink: /p1_sample3/ +folder: product1 --- ## Sample Content @@ -13,11 +14,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product1/p1_sample4.md b/product1/p1_sample4.md index a4a91c4..9495388 100644 --- a/product1/p1_sample4.md +++ b/product1/p1_sample4.md @@ -4,6 +4,7 @@ keywords: sample summary: "This is just a sample topic..." sidebar: product1_sidebar permalink: /p1_sample4/ +folder: product1 --- ## Sample Content @@ -13,11 +14,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product1/p1_sample5.md b/product1/p1_sample5.md index 5cce9ff..81b8d6e 100644 --- a/product1/p1_sample5.md +++ b/product1/p1_sample5.md @@ -4,6 +4,7 @@ keywords: sample summary: "This is just a sample topic..." sidebar: product1_sidebar permalink: /p1_sample5/ +folder: product1 --- ## Sample Content @@ -13,11 +14,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product1/p1_sample6.md b/product1/p1_sample6.md index 2499d7c..58918c2 100644 --- a/product1/p1_sample6.md +++ b/product1/p1_sample6.md @@ -4,6 +4,7 @@ keywords: sample summary: "This is just a sample topic..." sidebar: product1_sidebar permalink: /p1_sample6/ +folder: product1 --- ## Sample Content @@ -13,11 +14,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product1/p1_sample7.md b/product1/p1_sample7.md index 526dfa2..9bd9675 100644 --- a/product1/p1_sample7.md +++ b/product1/p1_sample7.md @@ -4,6 +4,7 @@ keywords: sample summary: "This is just a sample topic..." sidebar: product1_sidebar permalink: /p1_sample7/ +folder: product1 --- ## Sample Content @@ -13,11 +14,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product2/p2_landing_page.html b/product2/p2_landing_page.html index d7d3c77..9b111b3 100644 --- a/product2/p2_landing_page.html +++ b/product2/p2_landing_page.html @@ -4,6 +4,7 @@ keywords: mydoc sidebar: product2_sidebar toc: false permalink: /p2_landing_page/ +folder: product2 ---
    @@ -235,4 +236,4 @@ permalink: /p2_landing_page/
    - \ No newline at end of file + diff --git a/product2/p2_sample1.md b/product2/p2_sample1.md index 0df854e..ab6074f 100644 --- a/product2/p2_sample1.md +++ b/product2/p2_sample1.md @@ -7,6 +7,7 @@ permalink: /p2_sample1/ map: true map_name: usermap box_number: 1 +folder: product2 --- @@ -17,11 +18,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product2/p2_sample10.md b/product2/p2_sample10.md index 941b667..ffe7e93 100644 --- a/product2/p2_sample10.md +++ b/product2/p2_sample10.md @@ -8,6 +8,7 @@ map: true map_name: usermapcomplex box_number: 2 toc: false +folder: product2 --- ## Sample Content diff --git a/product2/p2_sample11.md b/product2/p2_sample11.md index f29ed44..e769d41 100644 --- a/product2/p2_sample11.md +++ b/product2/p2_sample11.md @@ -8,6 +8,7 @@ map: true map_name: usermapcomplex box_number: 2 toc: false +folder: product2 --- ## Sample Content diff --git a/product2/p2_sample12.md b/product2/p2_sample12.md index cc0d6c7..5d4c3a3 100644 --- a/product2/p2_sample12.md +++ b/product2/p2_sample12.md @@ -8,6 +8,7 @@ map: true map_name: usermapcomplex box_number: 3 toc: false +folder: product2 --- ## Sample Content diff --git a/product2/p2_sample13.md b/product2/p2_sample13.md index 99104d5..2e01e1b 100644 --- a/product2/p2_sample13.md +++ b/product2/p2_sample13.md @@ -8,6 +8,7 @@ map: true map_name: usermapcomplex box_number: 3 toc: false +folder: product2 --- diff --git a/product2/p2_sample14.md b/product2/p2_sample14.md index a528f79..11f7f36 100644 --- a/product2/p2_sample14.md +++ b/product2/p2_sample14.md @@ -8,6 +8,7 @@ map: true map_name: usermapcomplex box_number: 3 toc: false +folder: product2 --- diff --git a/product2/p2_sample2.md b/product2/p2_sample2.md index 32f4edc..b1db786 100644 --- a/product2/p2_sample2.md +++ b/product2/p2_sample2.md @@ -7,6 +7,7 @@ permalink: /p2_sample2/ map: true map_name: usermap box_number: 2 +folder: product2 --- @@ -18,11 +19,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product2/p2_sample3.md b/product2/p2_sample3.md index 8bf6442..9d7075d 100644 --- a/product2/p2_sample3.md +++ b/product2/p2_sample3.md @@ -7,6 +7,7 @@ permalink: /p2_sample3/ map: true map_name: usermap box_number: 3 +folder: product2 --- ## Sample Content @@ -16,11 +17,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product2/p2_sample4.md b/product2/p2_sample4.md index 0bd6750..473a5f8 100644 --- a/product2/p2_sample4.md +++ b/product2/p2_sample4.md @@ -7,6 +7,7 @@ permalink: /p2_sample4/ map: true map_name: usermap box_number: 4 +folder: product2 --- ## Sample Content @@ -16,11 +17,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product2/p2_sample5.md b/product2/p2_sample5.md index de24cee..746002c 100644 --- a/product2/p2_sample5.md +++ b/product2/p2_sample5.md @@ -7,6 +7,7 @@ permalink: /p2_sample5/ map: true map_name: usermap box_number: 5 +folder: product2 --- ## Sample Content @@ -16,11 +17,10 @@ Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). -## More sample content +## More sample content Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham. There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. - diff --git a/product2/p2_sample6.md b/product2/p2_sample6.md index 56e6f0c..7ae4b50 100644 --- a/product2/p2_sample6.md +++ b/product2/p2_sample6.md @@ -8,6 +8,7 @@ map: true map_name: usermapcomplex box_number: 1 toc: false +folder: product2 --- diff --git a/product2/p2_sample7.md b/product2/p2_sample7.md index 088327f..b671329 100644 --- a/product2/p2_sample7.md +++ b/product2/p2_sample7.md @@ -8,6 +8,7 @@ map: true map_name: usermapcomplex box_number: 1 toc: false +folder: product2 --- diff --git a/product2/p2_sample8.md b/product2/p2_sample8.md index 32472f5..dab58b6 100644 --- a/product2/p2_sample8.md +++ b/product2/p2_sample8.md @@ -8,6 +8,7 @@ map: true map_name: usermapcomplex box_number: 1 toc: false +folder: product2 --- diff --git a/product2/p2_sample9.md b/product2/p2_sample9.md index 09a3213..2f9c7b5 100644 --- a/product2/p2_sample9.md +++ b/product2/p2_sample9.md @@ -8,6 +8,7 @@ map: true map_name: usermapcomplex box_number: 2 toc: false +folder: product2 --- diff --git a/tags/tag_collaboration.html b/tags/tag_collaboration.html index ada06fc..8ccbe61 100644 --- a/tags/tag_collaboration.html +++ b/tags/tag_collaboration.html @@ -4,5 +4,6 @@ tagName: collaboration search: exclude permalink: /tag_collaboration/ sidebar: tags_sidebar +folder: tags --- -{% include taglogic.html %} \ No newline at end of file +{% include taglogic.html %} diff --git a/tags/tag_content_types.html b/tags/tag_content_types.html index effb7d6..a5437e1 100644 --- a/tags/tag_content_types.html +++ b/tags/tag_content_types.html @@ -4,5 +4,6 @@ tagName: content_types search: exclude permalink: /tag_content_types/ sidebar: tags_sidebar +folder: tags --- -{% include taglogic.html %} \ No newline at end of file +{% include taglogic.html %} diff --git a/tags/tag_formatting.html b/tags/tag_formatting.html index eca52cc..c5ef9e6 100644 --- a/tags/tag_formatting.html +++ b/tags/tag_formatting.html @@ -4,5 +4,6 @@ tagName: formatting search: exclude permalink: /tag_formatting/ sidebar: tags_sidebar +folder: tags --- -{% include taglogic.html %} \ No newline at end of file +{% include taglogic.html %} diff --git a/tags/tag_getting_started.html b/tags/tag_getting_started.html index 709da7c..ade764c 100644 --- a/tags/tag_getting_started.html +++ b/tags/tag_getting_started.html @@ -4,5 +4,6 @@ tagName: getting_started search: exclude permalink: /tag_getting_started/ sidebar: tags_sidebar +folder: tags --- -{% include taglogic.html %} \ No newline at end of file +{% include taglogic.html %} diff --git a/tags/tag_mobile.html b/tags/tag_mobile.html index 63c8b8d..6522952 100644 --- a/tags/tag_mobile.html +++ b/tags/tag_mobile.html @@ -5,5 +5,6 @@ tagName: mobile permalink: /tag_mobile/ sidebar: tags_sidebar sidebar: tags_sidebar +folder: tags --- -{% include taglogic.html %} \ No newline at end of file +{% include taglogic.html %} diff --git a/tags/tag_navigation.html b/tags/tag_navigation.html index 72c4402..e367eeb 100644 --- a/tags/tag_navigation.html +++ b/tags/tag_navigation.html @@ -4,5 +4,6 @@ tagName: navigation search: exclude permalink: /tag_navigation/ sidebar: tags_sidebar +folder: tags --- -{% include taglogic.html %} \ No newline at end of file +{% include taglogic.html %} diff --git a/tags/tag_news.html b/tags/tag_news.html index 7cc7a5f..e77c134 100644 --- a/tags/tag_news.html +++ b/tags/tag_news.html @@ -4,5 +4,6 @@ tagName: news search: exclude permalink: /tag_news/ sidebar: tags_sidebar +folder: tags --- -{% include taglogic.html %} \ No newline at end of file +{% include taglogic.html %} diff --git a/tags/tag_publishing.html b/tags/tag_publishing.html index 9acce42..1fe113d 100644 --- a/tags/tag_publishing.html +++ b/tags/tag_publishing.html @@ -4,5 +4,6 @@ tagName: publishing search: exclude permalink: /tag_publishing/ sidebar: tags_sidebar +folder: tags --- -{% include taglogic.html %} \ No newline at end of file +{% include taglogic.html %} diff --git a/tags/tag_single_sourcing.html b/tags/tag_single_sourcing.html index 9a7b92c..9d3cfe5 100644 --- a/tags/tag_single_sourcing.html +++ b/tags/tag_single_sourcing.html @@ -4,5 +4,6 @@ tagName: single_sourcing search: exclude permalink: /tag_single_sourcing/ sidebar: tags_sidebar +folder: tags --- -{% include taglogic.html %} \ No newline at end of file +{% include taglogic.html %} diff --git a/tags/tag_special_layouts.html b/tags/tag_special_layouts.html index 74d514f..f676878 100644 --- a/tags/tag_special_layouts.html +++ b/tags/tag_special_layouts.html @@ -4,5 +4,6 @@ tagName: special_layouts search: exclude permalink: /tag_special_layouts/ sidebar: tags_sidebar +folder: tags --- -{% include taglogic.html %} \ No newline at end of file +{% include taglogic.html %} diff --git a/tags/tag_troubleshooting.html b/tags/tag_troubleshooting.html index fcdce6c..d4f164c 100644 --- a/tags/tag_troubleshooting.html +++ b/tags/tag_troubleshooting.html @@ -4,5 +4,6 @@ tagName: troubleshooting search: exclude permalink: /tag_troubleshooting/ sidebar: tags_sidebar +folder: tags --- -{% include taglogic.html %} \ No newline at end of file +{% include taglogic.html %} diff --git a/urls.txt b/urls.txt index b7279ad..5bb1136 100644 --- a/urls.txt +++ b/urls.txt @@ -32,41 +32,6 @@ sidebar: {% endfor %} -{% comment %} - _ -| |_ ___ _ __ _ __ __ ___ __ -| __/ _ \| '_ \| '_ \ / _` \ \ / / -| || (_) | |_) | | | | (_| |\ V / - \__\___/| .__/|_| |_|\__,_| \_/ - |_| -{% endcomment %} - -{% for entry in site.data.topnav.topnav %} -{% for item in entry.items %} -{% unless item.external_url %} -{{item.url | replace: "/", ""| replace: "\", ""}}: - title: "{{item.title}}" - url: "{{item.url | replace: "/", ""| replace: "\", ""}}" - link: "{{item.title}}" -{% endunless %} -{% endfor %} -{% endfor %} - -{% for entry in site.data.topnav.topnav_dropdowns %} -{% for folder in entry.folders %} -{% for folderitem in folder.folderitems %} -{% unless folderitem.external_url %} -{{folderitem.url | replace: "/", ""| replace: "\", "" }}: - title: "{{folderitem.title}}" - url: "{{folderitem.url| replace: "/", ""| replace: "\", ""}}" - link: "{{folderitem.title}}" -{% endunless %} -{% endfor %} -{% endfor %} -{% endfor %} - - - {% comment %} _ @@ -99,4 +64,4 @@ sidebar: {% endunless %} {% endfor %} {% endfor %} -{% endfor %} \ No newline at end of file +{% endfor %}
    ApplesA small, somewhat round and often red-colored, crispy fruit grown on trees. + A small, somewhat round and often red-colored, crispy fruit grown on trees. Fruit Fuji