fixed github edit me links. also added doc for using variables with include parameters for notes, callouts, etc.
This commit is contained in:
tomjohnson1492
parent
6653e1a846
commit
f55c60e4d1
@ -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
|
||||
|
||||
|
||||
@ -33,13 +33,12 @@ layout: default
|
||||
|
||||
{% if site.github_editme_path %}
|
||||
|
||||
<a target="_blank" href="https://github.com/{{site.github_editme_path}}{% unless page.url contains "html" %}{{page.url | replace: '.html', '.md'}}{% endunless %}{% if page.url contains "html" %}{{page.url }}{% endif %}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
|
||||
{% endif %}
|
||||
|
||||
{% endunless %}
|
||||
<a target="_blank" href="https://github.com/{{site.github_editme_path}}/{{page.folder}}/{{page.url | remove: "/" | append: ".md"}}{% endif %}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
|
||||
|
||||
{{content}}
|
||||
|
||||
{% endunless %}
|
||||
|
||||
<div class="tags">
|
||||
{% if page.tags != null %}
|
||||
<b>Tags: </b>
|
||||
|
||||
3
index.md
3
index.md
@ -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.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -5,6 +5,7 @@ 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
|
||||
@ -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).
|
||||
|
||||
|
||||
@ -6,6 +6,7 @@ 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
|
||||
|
||||
@ -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 %}<div markdown="span" class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note:</b> {{include.content}}{% endraw %}</div>
|
||||
```
|
||||
|
||||
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 `<br/><br/>` 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. <br/><br/>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.
|
||||
|
||||
@ -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 }})
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -9,6 +9,7 @@ series: "Getting Started"
|
||||
weight: 10
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_build_scripts/
|
||||
folder: mydoc
|
||||
---
|
||||
|
||||
{% include custom/getting_started_series.html %}
|
||||
|
||||
@ -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
|
||||
|
||||
@ -7,6 +7,7 @@ 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
|
||||
@ -23,10 +24,7 @@ Here's the code for that button on the page.html layout:
|
||||
|
||||
{% if site.github_editme_path %}
|
||||
|
||||
<a target="_blank" href="https://github.com/{{site.github_editme_path}}{% unless page.url contains "html" %}{{page.url | replace: '.html', '.md'}}{% endunless %}{% if page.url contains "html" %}{{page.url }}{% endif %}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
|
||||
{% endif %}
|
||||
|
||||
{% endunless %}
|
||||
<a target="_blank" href="https://github.com/{{site.github_editme_path}}/{{page.folder}}{{page.url | append: ".md"}}{% endif %}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
|
||||
@ -6,6 +6,7 @@ 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
|
||||
@ -151,4 +152,3 @@ Then create a folder called \_data_beta.
|
||||
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.
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
<p>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 <code>div</code> tags), just look at the source in the mydoc_faq.html theme file.</p>
|
||||
@ -131,4 +132,3 @@ toc: false
|
||||
<!-- /.panel -->
|
||||
</div>
|
||||
<!-- /.panel-group -->
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -6,6 +6,7 @@ keywords: git, github, collaboration, interaction, file sharing, push
|
||||
published: false
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_git_collaboration/
|
||||
folder: mydoc
|
||||
---
|
||||
|
||||
|
||||
@ -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` |
|
||||
| | |
|
||||
|
||||
|
||||
@ -7,6 +7,7 @@ summary: "Your glossary page can take advantage of definitions stored in a data
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_glossary/
|
||||
toc: false
|
||||
folder: mydoc
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
@ -222,4 +223,3 @@ You can use any of the following:
|
||||
The only difference is the color of the left bar.
|
||||
|
||||
Callouts are explained in a bit more detail in <a href="{{ "/mydoc_alerts" | prepend: site.baseurl }}">Alerts</a>.
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -5,6 +5,7 @@ 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
|
||||
|
||||
@ -3,6 +3,7 @@ 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}}
|
||||
|
||||
@ -3,6 +3,7 @@ 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:
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: Introduction
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_introduction/
|
||||
folder: mydoc
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@ -6,6 +6,7 @@ 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
|
||||
|
||||
@ -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:
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -6,6 +6,7 @@ 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
|
||||
---
|
||||
|
||||
|
||||
@ -101,4 +102,3 @@ By setting a cookie, if the user refreshes the page, the active tab is the tab t
|
||||
## 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.
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -6,6 +6,7 @@ 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
|
||||
|
||||
@ -6,6 +6,7 @@ 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
|
||||
@ -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. |
|
||||
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -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....
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
|
||||
@ -6,6 +6,7 @@ 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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -6,6 +6,7 @@ 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
|
||||
|
||||
@ -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 %}
|
||||
|
||||
|
||||
|
||||
@ -6,6 +6,7 @@ weight: 2
|
||||
last_updated: March 20, 2016
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_seriesdemo2/
|
||||
folder: mydoc
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -7,6 +7,7 @@ weight: 3
|
||||
last_updated: March 20, 2016
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_seriesdemo3/
|
||||
folder: mydoc
|
||||
---
|
||||
|
||||
{% include custom/series_acme.html %}
|
||||
|
||||
@ -6,6 +6,7 @@ weight: 4
|
||||
last_updated: March 20, 2016
|
||||
sidebar: mydoc_sidebar
|
||||
permalink: /mydoc_seriesdemo4/
|
||||
folder: mydoc
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
|
||||
@ -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 <a href="mailto:tomjohnson1492@gmail.com">tomjohnson1492@gmail.com</a>. You can also [create issues directly within the Github repository here](https://github.com/tomjohnson1492/jekyll-doc/issues).
|
||||
@ -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.
|
||||
@ -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.
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
@ -73,4 +74,3 @@ The keywords you must add to specify the highlighting (in the previous example,
|
||||
* dotnet
|
||||
* xml
|
||||
* http
|
||||
|
||||
|
||||
@ -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" %}
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
|
||||
@ -183,4 +184,3 @@ If you don't want tags to appear at all on your page, remove the tags property f
|
||||
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 <a href="{{ "/mydoc_webstorm_text_editor" | prepend: site.baseurl }}">WebStorm Text Editor</a> for tips on creating file templates in WebStorm.
|
||||
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -6,6 +6,7 @@ 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
|
||||
@ -72,7 +73,3 @@ If the sidebar levels aren't collapsed, usually your JavaScript is broken somewh
|
||||
### 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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -4,6 +4,7 @@ sidebar: home_sidebar
|
||||
keywords: news, blog, updates, release notes, announcements
|
||||
permalink: /news/
|
||||
toc: false
|
||||
folder: news
|
||||
---
|
||||
|
||||
<div class="home">
|
||||
|
||||
@ -4,6 +4,7 @@ sidebar: tags_sidebar
|
||||
keywords: news, blog, updates, release notes, announcements
|
||||
permalink: /news_archive/
|
||||
toc: false
|
||||
folder: news
|
||||
---
|
||||
|
||||
<div class="home">
|
||||
|
||||
@ -4,6 +4,7 @@ keywords: mydoc
|
||||
sidebar: product1_sidebar
|
||||
toc: false
|
||||
permalink: /p1_landing_page/
|
||||
folder: product1
|
||||
---
|
||||
<div class="row">
|
||||
<div class="col-lg-12">
|
||||
|
||||
@ -4,6 +4,7 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample1/
|
||||
folder: product1
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -20,4 +21,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -4,6 +4,7 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample2/
|
||||
folder: product1
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -20,4 +21,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -4,6 +4,7 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample3/
|
||||
folder: product1
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -20,4 +21,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -4,6 +4,7 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample4/
|
||||
folder: product1
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -20,4 +21,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -4,6 +4,7 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample5/
|
||||
folder: product1
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -20,4 +21,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -4,6 +4,7 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample6/
|
||||
folder: product1
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -20,4 +21,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -4,6 +4,7 @@ keywords: sample
|
||||
summary: "This is just a sample topic..."
|
||||
sidebar: product1_sidebar
|
||||
permalink: /p1_sample7/
|
||||
folder: product1
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -20,4 +21,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -4,6 +4,7 @@ keywords: mydoc
|
||||
sidebar: product2_sidebar
|
||||
toc: false
|
||||
permalink: /p2_landing_page/
|
||||
folder: product2
|
||||
---
|
||||
<div class="row">
|
||||
<div class="col-lg-12">
|
||||
|
||||
@ -7,6 +7,7 @@ permalink: /p2_sample1/
|
||||
map: true
|
||||
map_name: usermap
|
||||
box_number: 1
|
||||
folder: product2
|
||||
---
|
||||
|
||||
|
||||
@ -24,4 +25,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -8,6 +8,7 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 2
|
||||
toc: false
|
||||
folder: product2
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
|
||||
@ -8,6 +8,7 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 2
|
||||
toc: false
|
||||
folder: product2
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
|
||||
@ -8,6 +8,7 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 3
|
||||
toc: false
|
||||
folder: product2
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
|
||||
@ -8,6 +8,7 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 3
|
||||
toc: false
|
||||
folder: product2
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -8,6 +8,7 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 3
|
||||
toc: false
|
||||
folder: product2
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -7,6 +7,7 @@ permalink: /p2_sample2/
|
||||
map: true
|
||||
map_name: usermap
|
||||
box_number: 2
|
||||
folder: product2
|
||||
---
|
||||
|
||||
|
||||
@ -25,4 +26,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -7,6 +7,7 @@ permalink: /p2_sample3/
|
||||
map: true
|
||||
map_name: usermap
|
||||
box_number: 3
|
||||
folder: product2
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -23,4 +24,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -7,6 +7,7 @@ permalink: /p2_sample4/
|
||||
map: true
|
||||
map_name: usermap
|
||||
box_number: 4
|
||||
folder: product2
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -23,4 +24,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -7,6 +7,7 @@ permalink: /p2_sample5/
|
||||
map: true
|
||||
map_name: usermap
|
||||
box_number: 5
|
||||
folder: product2
|
||||
---
|
||||
|
||||
## Sample Content
|
||||
@ -23,4 +24,3 @@ Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots
|
||||
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.
|
||||
|
||||
|
||||
@ -8,6 +8,7 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 1
|
||||
toc: false
|
||||
folder: product2
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -8,6 +8,7 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 1
|
||||
toc: false
|
||||
folder: product2
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -8,6 +8,7 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 1
|
||||
toc: false
|
||||
folder: product2
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -8,6 +8,7 @@ map: true
|
||||
map_name: usermapcomplex
|
||||
box_number: 2
|
||||
toc: false
|
||||
folder: product2
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -4,5 +4,6 @@ tagName: collaboration
|
||||
search: exclude
|
||||
permalink: /tag_collaboration/
|
||||
sidebar: tags_sidebar
|
||||
folder: tags
|
||||
---
|
||||
{% include taglogic.html %}
|
||||
@ -4,5 +4,6 @@ tagName: content_types
|
||||
search: exclude
|
||||
permalink: /tag_content_types/
|
||||
sidebar: tags_sidebar
|
||||
folder: tags
|
||||
---
|
||||
{% include taglogic.html %}
|
||||
@ -4,5 +4,6 @@ tagName: formatting
|
||||
search: exclude
|
||||
permalink: /tag_formatting/
|
||||
sidebar: tags_sidebar
|
||||
folder: tags
|
||||
---
|
||||
{% include taglogic.html %}
|
||||
@ -4,5 +4,6 @@ tagName: getting_started
|
||||
search: exclude
|
||||
permalink: /tag_getting_started/
|
||||
sidebar: tags_sidebar
|
||||
folder: tags
|
||||
---
|
||||
{% include taglogic.html %}
|
||||
@ -5,5 +5,6 @@ tagName: mobile
|
||||
permalink: /tag_mobile/
|
||||
sidebar: tags_sidebar
|
||||
sidebar: tags_sidebar
|
||||
folder: tags
|
||||
---
|
||||
{% include taglogic.html %}
|
||||
@ -4,5 +4,6 @@ tagName: navigation
|
||||
search: exclude
|
||||
permalink: /tag_navigation/
|
||||
sidebar: tags_sidebar
|
||||
folder: tags
|
||||
---
|
||||
{% include taglogic.html %}
|
||||
@ -4,5 +4,6 @@ tagName: news
|
||||
search: exclude
|
||||
permalink: /tag_news/
|
||||
sidebar: tags_sidebar
|
||||
folder: tags
|
||||
---
|
||||
{% include taglogic.html %}
|
||||
@ -4,5 +4,6 @@ tagName: publishing
|
||||
search: exclude
|
||||
permalink: /tag_publishing/
|
||||
sidebar: tags_sidebar
|
||||
folder: tags
|
||||
---
|
||||
{% include taglogic.html %}
|
||||
@ -4,5 +4,6 @@ tagName: single_sourcing
|
||||
search: exclude
|
||||
permalink: /tag_single_sourcing/
|
||||
sidebar: tags_sidebar
|
||||
folder: tags
|
||||
---
|
||||
{% include taglogic.html %}
|
||||
@ -4,5 +4,6 @@ tagName: special_layouts
|
||||
search: exclude
|
||||
permalink: /tag_special_layouts/
|
||||
sidebar: tags_sidebar
|
||||
folder: tags
|
||||
---
|
||||
{% include taglogic.html %}
|
||||
@ -4,5 +4,6 @@ tagName: troubleshooting
|
||||
search: exclude
|
||||
permalink: /tag_troubleshooting/
|
||||
sidebar: tags_sidebar
|
||||
folder: tags
|
||||
---
|
||||
{% include taglogic.html %}
|
||||
35
urls.txt
35
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: "<a href='{{item.url}}'>{{item.title}}</a>"
|
||||
{% 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: "<a href='{{folderitem.url}}'>{{folderitem.title}}</a>"
|
||||
{% endunless %}
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
|
||||
|
||||
|
||||
|
||||
{% comment %}
|
||||
_
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user