updated gemfile; also updated links docs

This commit is contained in:
Tom Johnson
2019-05-26 00:07:24 -07:00
parent 3f04fb81c3
commit 43665be576
3 changed files with 46 additions and 113 deletions

View File

@ -1,12 +1,12 @@
GEM GEM
remote: https://rubygems.org/ remote: https://rubygems.org/
specs: specs:
activesupport (4.2.10) activesupport (4.2.11.1)
i18n (~> 0.7) i18n (~> 0.7)
minitest (~> 5.1) minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4) thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1) tzinfo (~> 1.1)
addressable (2.5.2) addressable (2.6.0)
public_suffix (>= 2.0.2, < 4.0) public_suffix (>= 2.0.2, < 4.0)
coffee-script (2.4.1) coffee-script (2.4.1)
coffee-script-source coffee-script-source
@ -15,38 +15,38 @@ GEM
colorator (1.1.0) colorator (1.1.0)
commonmarker (0.17.13) commonmarker (0.17.13)
ruby-enum (~> 0.5) ruby-enum (~> 0.5)
concurrent-ruby (1.1.3) concurrent-ruby (1.1.5)
dnsruby (1.61.2) dnsruby (1.61.2)
addressable (~> 2.5) addressable (~> 2.5)
em-websocket (0.5.1) em-websocket (0.5.1)
eventmachine (>= 0.12.9) eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0) http_parser.rb (~> 0.6.0)
ethon (0.11.0) ethon (0.12.0)
ffi (>= 1.3.0) ffi (>= 1.3.0)
eventmachine (1.2.7) eventmachine (1.2.7)
execjs (2.7.0) execjs (2.7.0)
faraday (0.15.3) faraday (0.15.4)
multipart-post (>= 1.2, < 3) multipart-post (>= 1.2, < 3)
ffi (1.9.25) ffi (1.11.1)
forwardable-extended (2.6.0) forwardable-extended (2.6.0)
gemoji (3.0.0) gemoji (3.0.1)
github-pages (193) github-pages (198)
activesupport (= 4.2.10) activesupport (= 4.2.11.1)
github-pages-health-check (= 1.8.1) github-pages-health-check (= 1.16.1)
jekyll (= 3.7.4) jekyll (= 3.8.5)
jekyll-avatar (= 0.6.0) jekyll-avatar (= 0.6.0)
jekyll-coffeescript (= 1.1.1) jekyll-coffeescript (= 1.1.1)
jekyll-commonmark-ghpages (= 0.1.5) jekyll-commonmark-ghpages (= 0.1.5)
jekyll-default-layout (= 0.1.4) jekyll-default-layout (= 0.1.4)
jekyll-feed (= 0.11.0) jekyll-feed (= 0.11.0)
jekyll-gist (= 1.5.0) jekyll-gist (= 1.5.0)
jekyll-github-metadata (= 2.9.4) jekyll-github-metadata (= 2.12.1)
jekyll-mentions (= 1.4.1) jekyll-mentions (= 1.4.1)
jekyll-optional-front-matter (= 0.3.0) jekyll-optional-front-matter (= 0.3.0)
jekyll-paginate (= 1.1.0) jekyll-paginate (= 1.1.0)
jekyll-readme-index (= 0.2.0) jekyll-readme-index (= 0.2.0)
jekyll-redirect-from (= 0.14.0) jekyll-redirect-from (= 0.14.0)
jekyll-relative-links (= 0.5.3) jekyll-relative-links (= 0.6.0)
jekyll-remote-theme (= 0.3.1) jekyll-remote-theme (= 0.3.1)
jekyll-sass-converter (= 1.5.2) jekyll-sass-converter (= 1.5.2)
jekyll-seo-tag (= 2.5.0) jekyll-seo-tag (= 2.5.0)
@ -66,28 +66,28 @@ GEM
jekyll-theme-tactile (= 0.1.1) jekyll-theme-tactile (= 0.1.1)
jekyll-theme-time-machine (= 0.1.1) jekyll-theme-time-machine (= 0.1.1)
jekyll-titles-from-headings (= 0.5.1) jekyll-titles-from-headings (= 0.5.1)
jemoji (= 0.10.1) jemoji (= 0.10.2)
kramdown (= 1.17.0) kramdown (= 1.17.0)
liquid (= 4.0.0) liquid (= 4.0.0)
listen (= 3.1.5) listen (= 3.1.5)
mercenary (~> 0.3) mercenary (~> 0.3)
minima (= 2.5.0) minima (= 2.5.0)
nokogiri (>= 1.8.2, < 2.0) nokogiri (>= 1.8.5, < 2.0)
rouge (= 2.2.1) rouge (= 2.2.1)
terminal-table (~> 1.4) terminal-table (~> 1.4)
github-pages-health-check (1.8.1) github-pages-health-check (1.16.1)
addressable (~> 2.3) addressable (~> 2.3)
dnsruby (~> 1.60) dnsruby (~> 1.60)
octokit (~> 4.0) octokit (~> 4.0)
public_suffix (~> 2.0) public_suffix (~> 3.0)
typhoeus (~> 1.3) typhoeus (~> 1.3)
html-pipeline (2.9.1) html-pipeline (2.11.0)
activesupport (>= 2) activesupport (>= 2)
nokogiri (>= 1.4) nokogiri (>= 1.4)
http_parser.rb (0.6.0) http_parser.rb (0.6.0)
i18n (0.9.5) i18n (0.9.5)
concurrent-ruby (~> 1.0) concurrent-ruby (~> 1.0)
jekyll (3.7.4) jekyll (3.8.5)
addressable (~> 2.4) addressable (~> 2.4)
colorator (~> 1.0) colorator (~> 1.0)
em-websocket (~> 0.5) em-websocket (~> 0.5)
@ -105,9 +105,9 @@ GEM
jekyll-coffeescript (1.1.1) jekyll-coffeescript (1.1.1)
coffee-script (~> 2.2) coffee-script (~> 2.2)
coffee-script-source (~> 1.11.1) coffee-script-source (~> 1.11.1)
jekyll-commonmark (1.2.0) jekyll-commonmark (1.3.1)
commonmarker (~> 0.14) commonmarker (~> 0.14)
jekyll (>= 3.0, < 4.0) jekyll (>= 3.7, < 5.0)
jekyll-commonmark-ghpages (0.1.5) jekyll-commonmark-ghpages (0.1.5)
commonmarker (~> 0.17.6) commonmarker (~> 0.17.6)
jekyll-commonmark (~> 1) jekyll-commonmark (~> 1)
@ -118,8 +118,8 @@ GEM
jekyll (~> 3.3) jekyll (~> 3.3)
jekyll-gist (1.5.0) jekyll-gist (1.5.0)
octokit (~> 4.2) octokit (~> 4.2)
jekyll-github-metadata (2.9.4) jekyll-github-metadata (2.12.1)
jekyll (~> 3.1) jekyll (~> 3.4)
octokit (~> 4.0, != 4.4.0) octokit (~> 4.0, != 4.4.0)
jekyll-mentions (1.4.1) jekyll-mentions (1.4.1)
html-pipeline (~> 2.3) html-pipeline (~> 2.3)
@ -131,7 +131,7 @@ GEM
jekyll (~> 3.0) jekyll (~> 3.0)
jekyll-redirect-from (0.14.0) jekyll-redirect-from (0.14.0)
jekyll (~> 3.3) jekyll (~> 3.3)
jekyll-relative-links (0.5.3) jekyll-relative-links (0.6.0)
jekyll (~> 3.3) jekyll (~> 3.3)
jekyll-remote-theme (0.3.1) jekyll-remote-theme (0.3.1)
jekyll (~> 3.5) jekyll (~> 3.5)
@ -185,9 +185,9 @@ GEM
jekyll-seo-tag (~> 2.0) jekyll-seo-tag (~> 2.0)
jekyll-titles-from-headings (0.5.1) jekyll-titles-from-headings (0.5.1)
jekyll (~> 3.3) jekyll (~> 3.3)
jekyll-watch (2.1.2) jekyll-watch (2.2.1)
listen (~> 3.0) listen (~> 3.0)
jemoji (0.10.1) jemoji (0.10.2)
gemoji (~> 3.0) gemoji (~> 3.0)
html-pipeline (~> 2.2) html-pipeline (~> 2.2)
jekyll (~> 3.0) jekyll (~> 3.0)
@ -198,37 +198,37 @@ GEM
rb-inotify (~> 0.9, >= 0.9.7) rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2) ruby_dep (~> 1.2)
mercenary (0.3.6) mercenary (0.3.6)
mini_portile2 (2.3.0) mini_portile2 (2.4.0)
minima (2.5.0) minima (2.5.0)
jekyll (~> 3.5) jekyll (~> 3.5)
jekyll-feed (~> 0.9) jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1) jekyll-seo-tag (~> 2.1)
minitest (5.11.3) minitest (5.11.3)
multipart-post (2.0.0) multipart-post (2.1.1)
nokogiri (1.8.5) nokogiri (1.10.3)
mini_portile2 (~> 2.3.0) mini_portile2 (~> 2.4.0)
octokit (4.13.0) octokit (4.14.0)
sawyer (~> 0.8.0, >= 0.5.3) sawyer (~> 0.8.0, >= 0.5.3)
pathutil (0.16.2) pathutil (0.16.2)
forwardable-extended (~> 2.6) forwardable-extended (~> 2.6)
public_suffix (2.0.5) public_suffix (3.0.3)
rb-fsevent (0.10.3) rb-fsevent (0.10.3)
rb-inotify (0.9.10) rb-inotify (0.10.0)
ffi (>= 0.5.0, < 2) ffi (~> 1.0)
rouge (2.2.1) rouge (2.2.1)
ruby-enum (0.7.2) ruby-enum (0.7.2)
i18n i18n
ruby_dep (1.5.0) ruby_dep (1.5.0)
rubyzip (1.2.2) rubyzip (1.2.3)
safe_yaml (1.0.4) safe_yaml (1.0.5)
sass (3.7.2) sass (3.7.4)
sass-listen (~> 4.0.0) sass-listen (~> 4.0.0)
sass-listen (4.0.0) sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4) rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7) rb-inotify (~> 0.9, >= 0.9.7)
sawyer (0.8.1) sawyer (0.8.2)
addressable (>= 2.3.5, < 2.6) addressable (>= 2.3.5)
faraday (~> 0.8, < 1.0) faraday (> 0.8, < 2.0)
terminal-table (1.8.0) terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1) unicode-display_width (~> 1.1, >= 1.1.1)
thread_safe (0.3.6) thread_safe (0.3.6)
@ -236,7 +236,7 @@ GEM
ethon (>= 0.9.0) ethon (>= 0.9.0)
tzinfo (1.2.5) tzinfo (1.2.5)
thread_safe (~> 0.1) thread_safe (~> 0.1)
unicode-display_width (1.4.0) unicode-display_width (1.6.0)
PLATFORMS PLATFORMS
ruby ruby
@ -245,4 +245,4 @@ DEPENDENCIES
github-pages github-pages
BUNDLED WITH BUNDLED WITH
1.17.1 2.0.1

View File

@ -114,3 +114,6 @@ description: "Intended as a documentation theme based on Jekyll for technical wr
# needed for sitemap.xml file only # needed for sitemap.xml file only
# url: http://idratherbewriting.com # url: http://idratherbewriting.com
# baseurl: /documentation-theme-jekyll # baseurl: /documentation-theme-jekyll
github: [metadata]

View File

@ -26,74 +26,4 @@ When linking to internal pages, you can manually link to the pages like this:
[Icons](mydoc_icons.html) [Icons](mydoc_icons.html)
``` ```
However, if you change the file name, you'll have to update all of your links. It's much easier to use Automated links, as described in the next section. However, if you change the file name, you'll have to update all of your links.
## Automated links {#automatedlinks}
This method for automated links creates a master list of all links in a Markdown reference format based on entries in your sidebar table of contents.
With this Automated links method, make sure all your pages are referenced in a sidebar or topnav data file (inside \_data > sidebars). If they're not in a sidebar or top nav (such as links to headings on a page), list them in the `other.yml` file (which is in the \_data/sidebars folder).
The links.html file (in \_includes) will iterate through all your sidebars and create a list of reference-style markdown links based on the `url` properties in the sidebar items.
{% include note.html content="For the automated links method to work, each of your pages must have a `permalink` property in the frontmatter. The `permalink` property must match the file name. For example, if the file name is `somefile.html`, your permalink property would be `somefile.html`. See [Pages][mydoc_pages] for more details." %}
To implement managed links:
1. In your \_config.yml file, list each sidebar in the `sidebars` property &mdash; including the other.yml file too:
```yaml
sidebars:
- home_sidebar
- mydoc_sidebar
- product1_sidebar
- product2_sidebar
- other
```
2. At the bottom of each topic where you plan to include links, include the links.html file:
```
{% raw %}{% include links.html %}{% endraw %}
```
3. To link to a topic, use reference-style Markdown links, with the referent using the file name (without the file extension). For example:
```
See the [Icon][mydoc_icons] file.
```
Here's the result:
See the [Icon][mydoc_icons] file.
If the link doesn't render, check to make sure the page is correctly listed in the sidebar.
## Automated links to headings on pages {#bookmarklinks}
If you're linking to the specific heading from another page, first give the heading an ID:
```
## Some heading {#someheading}
```
Then add a property into the other.yml file in your \_data/sidebars folder:
```yaml
- title: Some link bookmark
url: /mydoc_pages.html#someIdTag
```
And reference it like this:
```
This is [Some link][mydoc_pages.html#someIdTag].
```
**Result:**
This is [Some link][mydoc_pages.html#someIdTag].
It's a little strange having the `.html#` in a reference like this, but it works.
{% include links.html %}