-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmydoc_pages.html
More file actions
486 lines (339 loc) · 24.2 KB
/
mydoc_pages.html
File metadata and controls
486 lines (339 loc) · 24.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="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 ...">
<meta name="keywords" content="getting_startedformattingcontent_types, pages, authoring, exclusion, frontmatter">
<title>Pages | IB-Ruby documentation</title>
<link rel="stylesheet" href="css/syntax.css">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
<link rel="stylesheet" href="css/modern-business.css">
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<link rel="stylesheet" href="css/customstyles.css">
<link rel="stylesheet" href="css/boxshadowproperties.css">
<!-- most color styles are extracted out to here -->
<link rel="stylesheet" href="css/theme-blue.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
<script src="js/jquery.navgoco.min.js"></script>
<!-- Latest compiled and minified JavaScript -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- Anchor.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.0/anchor.min.js"></script>
<script src="js/toc.js"></script>
<script src="js/customscripts.js"></script>
<link rel="shortcut icon" href="images/favicon.ico">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="alternate" type="application/rss+xml" title="documentation-theme-jekyll" href="https://github.com/feed.xml">
<script>
$(document).ready(function() {
// Initialize navgoco with default options
$("#mysidebar").navgoco({
caretHtml: '',
accordion: true,
openClass: 'active', // open
save: false, // leave false or nav highlighting doesn't work right
cookie: {
name: 'navgoco',
expires: false,
path: '/'
},
slide: {
duration: 400,
easing: 'swing'
}
});
$("#collapseAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', false);
});
$("#expandAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', true);
});
});
</script>
<script>
$(function () {
$('[data-toggle="tooltip"]').tooltip()
})
</script>
<script>
$(document).ready(function() {
$("#tg-sb-link").click(function() {
$("#tg-sb-sidebar").toggle();
$("#tg-sb-content").toggleClass('col-md-9');
$("#tg-sb-content").toggleClass('col-md-12');
$("#tg-sb-icon").toggleClass('fa-toggle-on');
$("#tg-sb-icon").toggleClass('fa-toggle-off');
});
});
</script>
</head>
<body>
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-static-top">
<div class="container topnavlinks">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="fa fa-home fa-lg navbar-brand" href="index.html"> <span class="projectTitle"> IB-Ruby Doc</span></a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<!-- toggle sidebar button -->
<li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
<!-- entries without drop-downs appear here -->
<li><a href="https://github.com/ib-ruby" target="_blank" rel="noopener">GitHub</a></li>
<li><a href="news">News</a></li>
<!-- entries with drop-downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
<!--comment out this block if you want to hide search-->
<li>
<!--start search-->
<div id="search-demo-container">
<input type="text" id="search-input" placeholder="search...">
<ul id="results-container"></ul>
</div>
<script src="js/jekyll-search.js" type="text/javascript"></script>
<script type="text/javascript">
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: 'search.json',
searchResultTemplate: '<li><a href="{url}" title="Pages">{title}</a></li>',
noResultsText: 'No results found.',
limit: 10,
fuzzy: true,
})
</script>
<!--end search-->
</li>
</ul>
</div>
</div>
<!-- /.container -->
</nav>
<!-- Page Content -->
<div class="container">
<div id="main">
<!-- Content Row -->
<div class="row">
<!-- Sidebar Column -->
<div class="col-md-3" id="tg-sb-sidebar">
<ul id="mysidebar" class="nav">
<li class="sidebarTitle"> </li>
<!-- if you aren't using the accordion, uncomment this block:
<p class="external">
<a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
</p>
-->
</ul>
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
<script>$("li.active").parents('li').toggleClass("active");</script>
</div>
<!-- Content Column -->
<div class="col-md-9" id="tg-sb-content">
<div class="post-header">
<h1 class="post-title-main">Pages</h1>
</div>
<div class="post-content">
<div class="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.</div>
<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
<script>
$( document ).ready(function() {
// Handler for .ready() called.
$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
/* this offset helps account for the space taken up by the floating toolbar. */
$('#toc').on('click', 'a', function() {
var target = $(this.getAttribute('href'))
, scroll_target = target.offset().top
$(window).scrollTop(scroll_target - 10);
return false
})
});
</script>
<div id="toc"></div>
<h2 id="where-to-author-content">Where to author content</h2>
<p>Use a text editor such as Sublime Text, WebStorm, IntelliJ, or Atom to create pages. Atom is recommended because it’s created by Github, which is driving some of the Jekyll development through Github Pages.</p>
<h2 id="where-to-save-pages">Where to save pages</h2>
<p>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.</p>
<p>The listing of all pages in the root directory (which happens when you add a permalink property to the pages) is what allows the relative linking and offline viewing of the site to work.</p>
<h2 id="frontmatter">Frontmatter</h2>
<p>Make sure each page has frontmatter at the top like this:</p>
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
<span class="na">title</span><span class="pi">:</span> <span class="s">Alerts</span>
<span class="na">tags</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">formatting</span><span class="pi">]</span>
<span class="na">keywords</span><span class="pi">:</span> <span class="s">notes, tips, cautions, warnings, admonitions</span>
<span class="na">last_updated</span><span class="pi">:</span> <span class="s">July 3, </span><span class="m">2016</span>
<span class="na">summary</span><span class="pi">:</span> <span class="s2">"</span><span class="s">You</span><span class="nv"> </span><span class="s">can</span><span class="nv"> </span><span class="s">insert</span><span class="nv"> </span><span class="s">notes,</span><span class="nv"> </span><span class="s">tips,</span><span class="nv"> </span><span class="s">warnings,</span><span class="nv"> </span><span class="s">and</span><span class="nv"> </span><span class="s">important</span><span class="nv"> </span><span class="s">alerts</span><span class="nv"> </span><span class="s">in</span><span class="nv"> </span><span class="s">your</span><span class="nv"> </span><span class="s">content."</span>
<span class="na">sidebar</span><span class="pi">:</span> <span class="s">mydoc_sidebar</span>
<span class="na">permalink</span><span class="pi">:</span> <span class="s">mydoc_alerts.html</span>
<span class="nn">---</span>
</code></pre></div></div>
<p>Frontmatter is always formatted with three hyphens at the top and bottom. Your frontmatter must have a <code class="language-plaintext highlighter-rouge">title</code> and <code class="language-plaintext highlighter-rouge">permalink</code> value. All the other values are optional.</p>
<p>Note that you cannot use variables in frontmatter.</p>
<p>The following table describes each of the frontmatter that you can use with this theme:</p>
<table>
<thead>
<tr>
<th>Frontmatter</th>
<th>Required?</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>title</strong></td>
<td>Required</td>
<td>The title for the page</td>
</tr>
<tr>
<td><strong>tags</strong></td>
<td>Optional</td>
<td>Tags for the page. Make all tags single words, with underscores if needed (rather than spaces). Separate them with commas. Enclose the whole list within brackets. Also, note that tags must be added to _data/tags_doc.yml to be allowed entrance into the page. This prevents tags from becoming somewhat random and unstructured. You must create a tag page for each one of your tags following the pattern shown in the tags folder. (Tag pages aren’t automatically created.)</td>
</tr>
<tr>
<td><strong>keywords</strong></td>
<td>Optional</td>
<td>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.</td>
</tr>
<tr>
<td><strong>last_updated</strong></td>
<td>Optional</td>
<td>The date the page was last updated. This information could helpful for readers trying to evaluate how current and authoritative information is. If included, the last_updated date appears in the footer of the page in small font.</td>
</tr>
<tr>
<td><strong>sidebar</strong></td>
<td>Required</td>
<td>Refers to the sidebar data file for this page. Don’t include the “.yml” file extension for the sidebar — just provide the file name. If no sidebar is specified, this value will inherit the <code class="language-plaintext highlighter-rouge">default</code> property set in your _config.yml file for the page’s frontmatter.</td>
</tr>
<tr>
<td><strong>summary</strong></td>
<td>Optional</td>
<td>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 <a href="http://www.nngroup.com/articles/corporate-blogs-front-page-structure/">Jakob Nielsen’s site</a> for a great example of page summaries.) The only drawback with summaries is that you can’t use variables in them.</td>
</tr>
<tr>
<td><strong>permalink</strong></td>
<td>Required</td>
<td>The permalink <em>must</em> match the filename in order for automated links to work. Additionally, you must include the “.html” in the filename. Do not put forward slashes around the permalink (this makes Jekyll put the file inside a folder in the output). When Jekyll builds the site, it will put the page into the root directory rather than leaving it in a subdirectory or putting it inside a folder and naming the file index.html. Having all files flattened in the root directory is essential for relative linking to work and for all paths to JS and CSS files to be valid.</td>
</tr>
<tr>
<td><strong>datatable</strong></td>
<td>Optional</td>
<td>‘true’. If you add <code class="language-plaintext highlighter-rouge">datatable: true</code> in the frontmatter, scripts for the <a href="https://www.datatables.net/">jQuery Datatables plugin</a> get included on the page. You can see the scripts that conditionally appear by looking in the _layouts/default.html page.</td>
</tr>
<tr>
<td><strong>toc</strong></td>
<td>Optional</td>
<td>If you specify <code class="language-plaintext highlighter-rouge">toc: false</code> 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.</td>
</tr>
</tbody>
</table>
<h2 id="colons-in-page-titles">Colons in page titles</h2>
<p>If you want to use a colon in your page title, you must enclose the title’s value in quotation marks.</p>
<h2 id="page-names-and-excluding-files-from-outputs">Page names and excluding files from outputs</h2>
<p>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:</p>
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">exclude</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">filename.md</span>
<span class="pi">-</span> <span class="s">subfolder_name/</span>
<span class="pi">-</span> <span class="s">mydoc_*</span>
<span class="pi">-</span> <span class="s">gitignore</span>
</code></pre></div></div>
<p>Wildcards will exclude every match after the <code class="language-plaintext highlighter-rouge">*</code>.</p>
<h2 id="saving-pages-as-drafts">Saving pages as drafts</h2>
<p>If you add <code class="language-plaintext highlighter-rouge">published: false</code> in the frontmatter, your page won’t be published. You can also move draft pages into the _drafts folder to exclude them from the build. With posts, you can also keep them as drafts by omitting the date in the title.</p>
<h2 id="markdown-or-html-format">Markdown or HTML format</h2>
<p>Pages can be either Markdown or HTML format (specified through either an .md or .html file extension).</p>
<p>If you use Markdown, you can also include HTML formatting where needed. But if your format is HTML, you must add a <code class="language-plaintext highlighter-rouge">markdown="1"</code> attribute to the element in order to use Markdown inside that HTML element:</p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code><div markdown="1">This is a [link](http://exmaple.com).</div>
</code></pre></div></div>
<p>For your Markdown files, note that a space or two indent will set text off as code or blocks, so avoid spacing indents unless intentional.</p>
<p>If you have a lot of HTML, as long as the top and bottom tags of the HTML are flush left in a Markdown file, all the tags inside those bookend HTML tags will render as HTML, regardless of their indentation. (This can be especially useful for tables.)</p>
<h2 id="page-names">Page names</h2>
<p>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 have topics with generic names such as “pages,” there won’t be naming conflicts.</p>
<p>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.</p>
<h2 id="kramdown-markdown">Kramdown Markdown</h2>
<p>Kramdown is the Markdown flavor used in the theme. This mostly aligns with Github-flavored Markdown, but with some differences in the indentation allowed within lists. Basically, Kramdown requires you to line up the indent between list items with the first starting character after the space in your list item numbering. See this <a href="http://idratherbewriting.com/2016/02/21/bug-with-kramdown-and-rouge-with-github-pages/">blog post on Kramdown and Rouge</a> for more details.</p>
<p>You can use standard Multimarkdown syntax for tables. You can also use fenced code blocks with lexers specifying the type of code. The configuration file shows the Markdown processor and extension:</p>
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">highlighter</span><span class="pi">:</span> <span class="s">rouge</span>
<span class="na">markdown</span><span class="pi">:</span> <span class="s">kramdown</span>
<span class="na">kramdown</span><span class="pi">:</span>
<span class="na">input</span><span class="pi">:</span> <span class="s">GFM</span>
<span class="na">auto_ids</span><span class="pi">:</span> <span class="no">true</span>
<span class="na">hard_wrap</span><span class="pi">:</span> <span class="no">false</span>
<span class="na">syntax_highlighter</span><span class="pi">:</span> <span class="s">rouge</span>
</code></pre></div></div>
<h2 id="automatic-mini-tocs">Automatic mini-TOCs</h2>
<p>By default, a TOC appears at the top of your pages and posts. If you don’t want the TOC to appear for a specific page, such as for a landing page or other homepage, add <code class="language-plaintext highlighter-rouge">toc: false</code> in the frontmatter of the page.</p>
<p>The mini-TOC requires you to use the <code class="language-plaintext highlighter-rouge">##</code> Markdown syntax for headings. If you use <code class="language-plaintext highlighter-rouge"><h2></code> elements, you must add an ID attribute for the heading element in order for it to appear in the mini-TOC (for example, <code class="language-plaintext highlighter-rouge"><h2 id="mysampleid">Heading</h2></code>.</p>
<h2 id="headings">Headings</h2>
<p>Use pound signs before the heading title to designate the level. Note that kramdown requires headings to have one space before and after the heading. Without this space above and below, the heading won’t render into HTML.</p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>## Second-level heading
</code></pre></div></div>
<p><strong>Result:</strong></p>
<h2 id="second-level-heading">Second-level heading</h2>
<hr />
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>### Third-level heading
</code></pre></div></div>
<p><strong>Result:</strong></p>
<h3 id="third-level-heading">Third-level heading</h3>
<hr />
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>#### Fourth-level heading
</code></pre></div></div>
<p><strong>Result:</strong></p>
<h4 id="fourth-level-heading">Fourth-level heading</h4>
<h2 id="someIdTag">Headings with ID Tags</h2>
<p>If you want to use a specific ID tag with your heading, add it like this:</p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>## Headings with ID Tags {#someIdTag}
</code></pre></div></div>
<p>Then you can reference it with a link like this on the same page:</p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>[Some link](#someIdTag)
</code></pre></div></div>
<p><strong>Result:</strong></p>
<p><a href="#someIdTag">Some link</a></p>
<p>For details about linking to headings on different pages, see <a href="mydoc_hyperlinks.html#bookmarklinks">Automated links to headings on pages</a>.</p>
<h2 id="specify-a-particular-page-layout">Specify a particular page layout</h2>
<p>The configuration file sets the default layout for pages as the “page” layout.</p>
<p>You can create other layouts inside the layouts folder. If you create a new layout, you can specify that your page use your new layout by adding <code class="language-plaintext highlighter-rouge">layout: mylayout.html</code> in the page’s frontmatter. Whatever layout you specify in the frontmatter of a page will override the layout default set in the configuration file.</p>
<h2 id="comments">Comments</h2>
<p>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.</p>
<div class="tags">
<b>Tags: </b>
<a href="tag_getting_started.html" class="btn btn-default navbar-btn cursorNorm" role="button">getting_started</a>
<a href="tag_formatting.html" class="btn btn-default navbar-btn cursorNorm" role="button">formatting</a>
<a href="tag_content_types.html" class="btn btn-default navbar-btn cursorNorm" role="button">content_types</a>
</div>
</div>
<hr class="shaded"/>
<footer>
<div class="row">
<div class="col-lg-12 footer">
©2021 IB-Ruby. All rights reserved. <br />
<span>Page last updated:</span> July 16, 2016<br/> Site last generated: Jul 27, 2021 <br />
<p><img src="images/company_logo.png" alt="Company logo"/></p>
</div>
</div>
</footer>
</div>
<!-- /.row -->
</div>
<!-- /.container -->
</div>
<!-- /#main -->
</div>
</body>
</html>