Added <hr>'s below tabbed topics for SSH and test page (#4232)

* added <hr>'s below tabs

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* update Tabs topic on test.md to show use of <hr>'s

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* added more information about toc_max/min

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
This commit is contained in:
Victoria Bialas 2017-08-16 19:38:09 -07:00 committed by GitHub
parent 2ab413d8c8
commit e90b12c425
5 changed files with 35 additions and 13 deletions

View File

@ -38,6 +38,7 @@ passphrases in your keychain.
{% endcapture %} {% endcapture %}
{{ mac-content-add | markdownify }} {{ mac-content-add | markdownify }}
<hr>
</div> </div>
<div id="win-add-keys" class="tab-pane fade"> <div id="win-add-keys" class="tab-pane fade">
@ -63,6 +64,7 @@ passphrases in your keychain.
{% endcapture %} {% endcapture %}
{{ win-content-add | markdownify }} {{ win-content-add | markdownify }}
<hr>
</div> </div>
<div id="linux-add-keys" class="tab-pane fade"> <div id="linux-add-keys" class="tab-pane fade">
@ -88,5 +90,6 @@ passphrases in your keychain.
{% endcapture %} {% endcapture %}
{{ linux-content-add | markdownify }} {{ linux-content-add | markdownify }}
<hr>
</div> </div>
</div> </div>

View File

@ -24,6 +24,7 @@ For example: `$ atom ~/.ssh/id_rsa.pub`
{% endcapture %} {% endcapture %}
{{ mac-content-copy | markdownify }} {{ mac-content-copy | markdownify }}
<hr>
</div> </div>
<div id="win-copy-keys" class="tab-pane fade"> <div id="win-copy-keys" class="tab-pane fade">
@ -45,6 +46,7 @@ For example: `$ notepad ~/.ssh/id_rsa.pub`
{% endcapture %} {% endcapture %}
{{ win-content-copy | markdownify }} {{ win-content-copy | markdownify }}
<hr>
</div> </div>
<div id="linux-copy-keys" class="tab-pane fade"> <div id="linux-copy-keys" class="tab-pane fade">
@ -69,5 +71,6 @@ For example: `$ vi ~/.ssh/id_rsa.pub`
{% endcapture %} {% endcapture %}
{{ linux-content-copy | markdownify }} {{ linux-content-copy | markdownify }}
<hr>
</div> </div>
</div> </div>

View File

@ -40,6 +40,7 @@
{% endcapture %} {% endcapture %}
{{ mac-content-find | markdownify }} {{ mac-content-find | markdownify }}
<hr>
</div> </div>
<div id="win-find-keys" class="tab-pane fade"> <div id="win-find-keys" class="tab-pane fade">
@ -77,6 +78,7 @@
{% endcapture %} {% endcapture %}
{{ win-content-find | markdownify }} {{ win-content-find | markdownify }}
<hr>
</div> </div>
<div id="linux-find-keys" class="tab-pane fade"> <div id="linux-find-keys" class="tab-pane fade">
@ -114,5 +116,6 @@
{% endcapture %} {% endcapture %}
{{ linux-content-find | markdownify }} {{ linux-content-find | markdownify }}
<hr>
</div> </div>
</div> </div>

View File

@ -36,6 +36,7 @@
``` ```
{% endcapture %} {% endcapture %}
{{ mac-content-gen | markdownify }} {{ mac-content-gen | markdownify }}
<hr>
</div> </div>
<div id="win-key-gen" class="tab-pane fade"> <div id="win-key-gen" class="tab-pane fade">
@ -69,6 +70,7 @@
``` ```
{% endcapture %} {% endcapture %}
{{ win-content-gen | markdownify }} {{ win-content-gen | markdownify }}
<hr>
</div> </div>
<div id="linux-key-gen" class="tab-pane fade"> <div id="linux-key-gen" class="tab-pane fade">
@ -102,5 +104,6 @@
``` ```
{% endcapture %} {% endcapture %}
{{ linux-content-gen | markdownify }} {{ linux-content-gen | markdownify }}
<hr>
</div> </div>
</div> </div>

36
test.md
View File

@ -2,19 +2,22 @@
description: Smoketest page description: Smoketest page
title: Testing page title: Testing page
hide_from_sitemap: true hide_from_sitemap: true
toc_min: 1
--- ---
# Heading 1 # Heading 1
Most pages don't actually have a H1 heading. The page title from the metadata is Most pages don't actually have a H1 heading. The page title from the metadata is
automatically inserted. automatically inserted. We have included it here to show all heading levels, and
set front matter as `toc_min: 1` so that it shows in the navigation bar (on-page
topics).
## Heading 2 ## Heading 2
This is the highest heading included in the right navigation bar. By default, this is the highest heading included in the right navigation bar. To
To include more heading levels, set `toc_min: 1` in the page-s front-matter. include more heading levels, set `toc_min: 1` in the page's front-matter (as is
You can go all the way to 6, but if `toc_min` is geater than `toc_max` then no done on this `test.md` page). You can go all the way to 6, but if `toc_min` is
headings will show. geater than `toc_max` then no headings will show.
### Heading 3 ### Heading 3
@ -251,6 +254,9 @@ You can nest captures within each other to represent more complex logic with Liq
## Bootstrap and CSS tricks ## Bootstrap and CSS tricks
Here are cool components you can include on Docs pages using
[Bootstrap](http://getbootstrap.com/) and [CSS](https://www.w3schools.com/css/).
### Tabs ### Tabs
Here are some tabs: Here are some tabs:
@ -260,12 +266,15 @@ Here are some tabs:
<li><a data-toggle="tab" data-target="#tab2">TAB 2 HEADER</a></li> <li><a data-toggle="tab" data-target="#tab2">TAB 2 HEADER</a></li>
</ul> </ul>
<div class="tab-content"> <div class="tab-content">
<div id="tab1" class="tab-pane fade in active">TAB 1 CONTENT</div> <div id="tab1" class="tab-pane fade in active">TAB 1 CONTENT<hr></div>
<div id="tab2" class="tab-pane fade">TAB 2 CONTENT</div> <div id="tab2" class="tab-pane fade">TAB 2 CONTENT<hr></div>
</div> </div>
You need to adjust the `id` and `data-target` values to match your use case. You need to adjust the `id` and `data-target` values to match your use case.
The `<hr>`'s are included simply to add visual separation between tabbed content
and the other topics on the page.
If you have Markdown inside the content of the `<div>`, just add `markdown="1"` If you have Markdown inside the content of the `<div>`, just add `markdown="1"`
as an attribute in the HTML for the `<div>` and Kramdown will render it. as an attribute in the HTML for the `<div>` and Kramdown will render it.
@ -279,12 +288,14 @@ as an attribute in the HTML for the `<div>` and Kramdown will render it.
- list item 1 - list item 1
- list item 2 - list item 2
<hr>
</div> </div>
<div id="tab4" class="tab-pane fade" markdown="1"> <div id="tab4" class="tab-pane fade" markdown="1">
#### Another Markdown header #### Another Markdown header
- list item 3 - list item 3
- list item 4 - list item 4
<hr>
</div> </div>
</div> </div>
@ -304,8 +315,8 @@ other tab set to match.
<li><a data-toggle="tab" data-target="#python" data-group="python">Python</a></li> <li><a data-toggle="tab" data-target="#python" data-group="python">Python</a></li>
</ul> </ul>
<div class="tab-content"> <div class="tab-content">
<div id="go" class="tab-pane fade in active">Go content here</div> <div id="go" class="tab-pane fade in active">Go content here<hr></div>
<div id="python" class="tab-pane fade in">Python content here</div> <div id="python" class="tab-pane fade in">Python content here<hr></div>
</div> </div>
And some content between the two sets, just for fun... And some content between the two sets, just for fun...
@ -315,8 +326,8 @@ And some content between the two sets, just for fun...
<li><a data-toggle="tab" data-target="#python-2" data-group="python">Python</a></li> <li><a data-toggle="tab" data-target="#python-2" data-group="python">Python</a></li>
</ul> </ul>
<div class="tab-content"> <div class="tab-content">
<div id="go-2" class="tab-pane fade in active">Go content here</div> <div id="go-2" class="tab-pane fade in active">Go content here<hr></div>
<div id="python-2" class="tab-pane fade in">Python content here</div> <div id="python-2" class="tab-pane fade in">Python content here<hr></div>
</div> </div>
@ -326,7 +337,6 @@ In a Bootstrap row, your columns need to add up to 12. Here are three cards in
a row, each of which takes up 1/3 (4/12) of the row. You need a couple `<br />`s a row, each of which takes up 1/3 (4/12) of the row. You need a couple `<br />`s
to clear the row before.<br /><br /> to clear the row before.<br /><br />
<div class="row"> <div class="row">
<div class="panel col-xs-12 col-md-4">This will take up 1/3 of the row unless the screen is small, <div class="panel col-xs-12 col-md-4">This will take up 1/3 of the row unless the screen is small,
then it will take up the whole row.</div> then it will take up the whole row.</div>
@ -556,7 +566,7 @@ $ some other command
$ echo "deb https://packages.docker.com/1.12/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list $ echo "deb https://packages.docker.com/1.12/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list
``` ```
### GO ### Go
```go ```go
incoming := map[string]interface{}{ incoming := map[string]interface{}{