1<!DOCTYPE html> 2<html lang="en" class="no-js"> 3 <!-- Copyright 2019-2021 Vanessa Sochat--> 4 5 6 7 8 9 10 11 12 13<head> 14<meta charset="utf-8"> 15<!-- This site is hosted on Netlify. Anyone can build and deploy a site 16 like this one for free: https://netlify.new/?utm_campaign=loops&utm_source=ai-legible&utm_medium=owned&utm_content=comment&utm_id=dfafc091-4339-4827-9cf6-21ebaa73dfef 17 Netlify hosting facts for this site: static/SSR served via Netlify Edge. --> 18<!-- Some HTML templates copyright 2019-2021 Vanessa Sochat | Apache 2.0 License --> 19<!-- Adapted and re-released as AsciiDocsy under Apache 2.0 and MIT licenses 20 in 2021 by Codewriting LLC --> 21 22<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> 23<meta name="generator" content="Jekyll+Asciidoctor" /> 24 25<meta name="robots" content="index, follow"> 26 27<link rel="canonical" href="https://asciidocsy.netlify.app/docs" /> 28<link rel="shortcut icon" href="/assets/images/favicons/favicon.ico" > 29<link rel="icon" type="image/png" href="/assets/images/favicons/favicon-16x16.png" sizes="16x16"> 30<link rel="icon" type="image/png" href="/assets/images/favicons/favicon-32x32.png" sizes="32x32"> 31<!-- 32<link rel="apple-touch-icon" href="/assets/images/favicons/apple-touch-icon-180x180.png" sizes="180x180"> 33<link rel="icon" type="image/png" href="/assets/images/favicons/android-36x36.png" sizes="36x36"> 34<link rel="icon" type="image/png" href="/assets/images/favicons/android-48x48.png" sizes="48x48"> 35<link rel="icon" type="image/png" href="/assets/images/favicons/android-72x72.png" sizes="72x72"> 36<link rel="icon" type="image/png" href="/assets/images/favicons/android-96x196.png" sizes="96x196"> 37<link rel="icon" type="image/png" href="/assets/images/favicons/android-144x144.png" sizes="144x144"> 38<link rel="icon" type="image/png" href="/assets/images/favicons/android-192x192.png" sizes="192x192"> 39--> 40 41<title> 42 43 AsciiDocsy Documentation | 44 45 AsciiDocsy Theme Documentation 46</title> 47 48<meta property="og:title" content="AsciiDocsy Documentation" /> 49<meta property="og:description" content="" /> 50<meta property="og:type" content="website" /> 51<meta property="og:url" content="" /> 52<meta property="og:site_name" content="" /> 53 54<meta itemprop="name" content="AsciiDocsy Documentation"> 55<meta itemprop="description" content=""> 56 57 58 59 60 61 62 63<link rel="stylesheet" href="/assets/css/bootstrap.css"/> 64<link rel="stylesheet" href="/assets/css/bootstrap-toc.css"/> 65<link rel="stylesheet" href="/assets/css/jquery.navgoco.css"/> 66<link rel="stylesheet" href="/assets/css/palette.css"/> 67<link rel="stylesheet" href="/assets/css/asciidoctor.css"/> 68<link rel="stylesheet" href="/assets/css/font-awesome.css"/> 69<link rel="stylesheet" href="/assets/css/skins/foundation.css" id="theme-skin"/> 70<link rel="stylesheet" href="/assets/css/syntax/hljs/a11y-light.css" id="syntax-skin"/> 71 72<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/instantsearch-theme-algolia.min.css"> 73<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/themes/reset-min.css" integrity="sha256-t2ATOGCtAIZNnzER679jwcFcKYfLlw01gli6F6oszk8=" crossorigin="anonymous"/> 74<link rel="stylesheet" href="/assets/css/asciidocsy.css"/> 75<link rel="stylesheet" href="/assets/css/custom.css"/> 76 77 78 79 80 81 82 83 84 85 86 87 88 89
90<script src="/assets/js/jquery-3.3.1.min.js" integrity="" crossorigin="anonymous"></script>
90 91 92 93
94<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
94 95 96 97
98<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="" crossorigin="anonymous"></script>
98 99 100 101
102<script src="/assets/js/jquery.cookie.js" integrity="" crossorigin="anonymous"></script>
102 103 104 105
106<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/instantsearch.production.min.js" integrity="sha256-LAGhRRdtVoD6RLo2qDQsU2mp+XVSciKRC8XPOBWmofM=" crossorigin="anonymous"></script>
106 107 108 109
110<script src="https://cdn.jsdelivr.net/autocomplete.js/0/autocomplete.min.js" integrity="" crossorigin="anonymous"></script>
110 111 112 113
114<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js" integrity="" crossorigin="anonymous"></script>
114 115 116 117
118<script src="/assets/js/anchor.min.js" integrity="" crossorigin="anonymous"></script>
118 119 120 121
122<script src="/assets/js/jquery.navgoco.js" integrity="" crossorigin="anonymous"></script>
122 123 124 125
126<script src="/assets/js/bootstrap-toc.js" integrity="" crossorigin="anonymous"></script>
126 127 128 129
130<script src="/assets/js/highlight.pack.js" integrity="" crossorigin="anonymous"></script>
130 131 132 133
134<script src="/assets/js/asciidoctor.min.js" integrity="" crossorigin="anonymous"></script>
134 135 136 137
138<script src="/assets/js/tabber.js" integrity="" crossorigin="anonymous"></script>
138 139 140 141
142<script src="/assets/js/toggler.js" integrity="" crossorigin="anonymous"></script>
142 143 144 145
146<script src="/assets/js/semantics.js" integrity="" crossorigin="anonymous"></script>
146 147 148
149<script> 150// invoke highligher.js 151hljs.highlightAll(); 152</script>
152 153 154 155 156 157 158 159</head> 160 161 162 163 164 165 166 167 168<body data-spy="scroll" data-target="#toc-side"> 169 170 171 172 173 174 175 <header><!-- DOCSITE REF/NAV --> 176 <nav id="nav-site" class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar td-navbar-fixed"> 177 <a class="navbar-brand" href="/"> 178 <span class="navbar-logo"></span> 179 <img src="" class="logo" width="50px"> 180 <span class="site-title">AsciiDocsy</span> 181 </a> 182 <div class="td-navbar-nav-scroll ml-md-auto align-content-end" id="navbarNavDropdown"> 183 <!-- nav menu --> 184<ul class="navbar-nav mt-2 mt-lg-0"> 185 186 187 188 189 190 <li class="nav-item mr-4 mb-2 mb-lg-0 dropdown"> 191 <a class="nav-link dropdown-toggle active" href="/docs" id="navbarDropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"> 192 Documentation</a> 193 <div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink"> 194 195 <a class="dropdown-item" href="/docs/theme"> 196 Theme Docs & Guides 197 </a> 198 199 <a class="dropdown-item" href="/docs/style"> 200 Docs-as-Code Style Guides 201 </a> 202 203 </div> 204 </li> 205 206 207 208 209 210 211 212 <li class="nav-item mr-4 mb-2 mb-lg-0 dropdown"> 213 <a class="nav-link dropdown-toggle " href="/about" id="navbarDropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"> 214 About</a> 215 <div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink"> 216 217 <a class="dropdown-item" href="/about#background"> 218 Theme Background 219 </a> 220 221 <a class="dropdown-item" href="https://github.com/docops"> 222 Doc Ops 223 </a> 224 225 </div> 226 </li> 227 228 229 230 231 232 233 234 <li class="nav-item mr-4 mb-2 mb-lg-0"> 235 <a class="nav-link " href="/docs/theme/history">Releases</a> 236 </li> 237 238 239 240</ul> 241 242 </div> 243 244 245 246 247 248 249 250 251 252 253 254
255<script> 256var hrefChanged = false; 257</script>
257 258<div class="aa-input-container" id="aa-input-container"> 259 <span class="algolia-autocomplete"> 260 <input id="search-site" type="search" class="aa-input-search aa-hint" autocomplete="off" readonly="" aria-hidden="true" spellcheck="false" tabindex="-1"/> 261 <input type="search" id="aa-search-site-input" class="aa-input-search aa-input" placeholder="Search non-docs PAGESâ¦" name="search" autocomplete="off" spellcheck="false" role="combobox" aria-autocomplete="both" aria-expanded="false" aria-owns="algolia-autocomplete-listbox-0" dir="auto"/> 262 <pre aria-hidden="true" style="position: absolute; visibility: hidden; white-space: pre; font-family: "Open Sans", Arial, "sans serif"; font-size: 13px; font-style: normal; font-variant: normal; font-weight: 400; word-spacing: 0px; letter-spacing: normal; text-indent: 0px; text-rendering: optimizelegibility; text-transform: none;"/> 263 </pre> 264 <span class="aa-dropdown-menu" role="listbox" id="algolia-autocomplete-listbox-0"/> 265 <div class="aa-dataset-1"></div> 266 </span> 267 </span> 268 <svg class="aa-input-icon" viewBox="654 -372 1664 1664"> 269 <path d="M1806,332c0-123.3-43.8-228.8-131.5-316.5C1586.8-72.2,1481.3-116,1358-116s-228.8,43.8-316.5,131.5 C953.8,103.2,910,208.7,910,332s43.8,228.8,131.5,316.5C1129.2,736.2,1234.7,780,1358,780s228.8-43.8,316.5-131.5 C1762.2,560.8,1806,455.3,1806,332z M2318,1164c0,34.7-12.7,64.7-38,90s-55.3,38-90,38c-36,0-66-12.7-90-38l-343-342 c-119.3,82.7-252.3,124-399,124c-95.3,0-186.5-18.5-273.5-55.5s-162-87-225-150s-113-138-150-225S654,427.3,654,332 s18.5-186.5,55.5-273.5s87-162,150-225s138-113,225-150S1262.7-372,1358-372s186.5,18.5,273.5,55.5s162,87,225,150s113,138,150,225 S2062,236.7,2062,332c0,146.7-41.3,279.7-124,399l343,343C2305.7,1098.7,2318,1128.7,2318,1164z"></path> 270 </svg> 271</div> 272<!-- Initialize autocomplete menu -->
273<script> 274$( "#aa-site-input" ).keydown(function(e) { 275 e = e || window.event; 276 if (!hrefChanged && (e.keyCode || e.which) == 13) { 277 // Enter key pressed 278 window.location.href = "/docs/search.html?q=" + $( "#aa-search-site-input" ).val().replace(' ', '+'); 279 } 280}); 281 282var client = algoliasearch('SELDDHION6', 'b9112b0485d58729c3e7c7b64291cbd9'); 283var index = client.initIndex('asciidocsy-pages'); 284// Initialize autocomplete on search input (ID selector must match). 285autocomplete('#aa-search-site-input', 286{ hint: true, autoselect: false }, { 287 source: autocomplete.sources.hits(index, {hitsPerPage: 5, typoTolerance: 'false', advancedSyntax: 'true'}), 288 // Value to be displayed in input control after user's suggestion selection. 289 displayKey: function(suggestion) { 290 var titleValue; 291 if (suggestion.title) { 292 titleValue = suggestion.title; 293 } else { 294 var idx = suggestion.slug.lastIndexOf("_"); 295 titleValue = suggestion.slug.substring(idx + 1).replace(/-/g, " "); 296 titleValue = titleValue.charAt(0).toUpperCase() + titleValue.slice(1); 297 } 298 299 return titleValue; 300 }, 301 // Hash of templates used when rendering dataset. 302 templates: { 303 empty: function(suggestion) { 304 // Add the see more results option when no suggestion is found...
305 // just in case the user prefers to search in the main search page. 306 var hrefValue = "/search?q=" + document.getElementById('aa-search-site-input').value.replace(' ', '+'); 307 return '<div class="aa-suggestion" role="option"><a id="show-more-link" class="suggestion-link" href="' + hrefValue + '">See more results...</a></div><div class="algolia-credit"><a href="https://www.algolia.com"><img src="/assets/images/search-by-algolia-light-background.svg"></div>'; 308 }, 309 footer: function(suggestion) { 310 // If no result is returned, don't add the show more results option 311 // cause it is added in the empty callback. 312 if (suggestion.isEmpty){ 313 return; 314 } 315 var hrefValue = "/search?q=" + document.getElementById('aa-search-site-input').value.replace(' ', '+'); 316 return '<div class="aa-suggestion" role="option"><a id="show-more-link" class="suggestion-link" href="' + hrefValue + '">See more results...</a></div><div class="algolia-credit"><a href="https://www.algolia.com"><img src="/assets/images/search-by-algolia-light-background.svg"></div>'; 317 }, 318 // 'suggestion' templating function used to render a single suggestion. 319 suggestion: function(suggestion) { 320 // Only preview the first 200 characters of the page. 321 var contentValue = ""; 322 if (suggestion._highlightResult.content) { 323 contentValue = suggestion._highlightResult.content.value 324 if (suggestion._highlightResult.content.value.length > 200) { 325 contentValue = suggestion._highlightResult.content.value.slice(0, 200) + '...' 326 } 327 } 328 329 // Add a title based on the link to the pages that don't have 330 // a title. The title will get the link's last underscore and 331 // then get the following words... usually that is the name of the page. 332 var titleValue; 333 if (suggestion.title) { 334 titleValue = suggestion.title; 335 } else { 336 var idx = suggestion.slug.lastIndexOf("_"); 337 titleValue = suggestion.slug.substring(idx + 1).replace(/-/g, " "); 338 titleValue = titleValue.charAt(0).toUpperCase() + titleValue.slice(1); 339 } 340 341 // Define target link. 342 var linkValue = window.location.href.substring(0, window.location.href.indexOf('') - 1) + suggestion.url; 343 344 return '<a class="suggestion-link" href="' + linkValue + '"><span>' + titleValue + '</span><span>' + 345 contentValue + '</span></a>'; 346 } 347 } 348}).on('autocomplete:selected', function(event, suggestion, dataset) { 349 if (event._args.length > 0) { 350 var linkValue; 351 if (suggestion) { 352 linkValue = window.location.href.substring(0, window.location.href.indexOf('') - 1) + suggestion.url; 353 } else { 354 // Show more results. 355 linkValue = "search.html?q=" + document.getElementById('aa-search-site-input').value.replace(' ', '+'); 356 } 357 window.location.href = linkValue; 358 hrefChanged = true; 359 } 360}); 361</script>
361 362 363 364 365 <div class="navbar-nav d-none d-lg-block"> 366 <a class="nav-link" href="https://github.com/DocOps/asciidocsy-jekyll-theme" target="_blank"> 367 <i class="icon fab fa fa-github fa-2x"></i> 368 </a> 369 </div> 370 371 </nav> 372</header> 373 374 375 376 377 378 379 380 <div class="container-fluid td-outer topic"> 381 <div class="td-main"> 382 <div class="row flex-xl-nowrap"> 383 384 <div id="sidebar-left" class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none"><!-- SUBJECT/PRODUCT REF/NAV --> 385 <div class="sticky-top sticky-offset"> 386 <div class="sidebar-top"> 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<script> 416var hrefChanged = false; 417</script>
417 418<div class="aa-input-container" id="aa-input-container"> 419 <span class="algolia-autocomplete"> 420 <input id="subject-search" type="search" class="aa-input-search aa-hint" autocomplete="off" readonly="" aria-hidden="true" spellcheck="false" tabindex="-1"/> 421 <input type="search" id="aa-subject-search-input" class="aa-input-search aa-input" placeholder="Search subject TOPICSâ¦" name="search" autocomplete="off" spellcheck="false" role="combobox" aria-autocomplete="both" aria-expanded="false" aria-owns="algolia-autocomplete-listbox-0" dir="auto"/> 422 <pre aria-hidden="true" style="position: absolute; visibility: hidden; white-space: pre; font-family: "Open Sans", Arial, "sans serif"; font-size: 13px; font-style: normal; font-variant: normal; font-weight: 400; word-spacing: 0px; letter-spacing: normal; text-indent: 0px; text-rendering: optimizelegibility; text-transform: none;"/> 423 </pre> 424 <span class="aa-dropdown-menu" role="listbox" id="algolia-autocomplete-listbox-0"/> 425 <div class="aa-dataset-1"></div> 426 </span> 427 </span> 428 <svg class="aa-input-icon" viewBox="654 -372 1664 1664"> 429 <path d="M1806,332c0-123.3-43.8-228.8-131.5-316.5C1586.8-72.2,1481.3-116,1358-116s-228.8,43.8-316.5,131.5 C953.8,103.2,910,208.7,910,332s43.8,228.8,131.5,316.5C1129.2,736.2,1234.7,780,1358,780s228.8-43.8,316.5-131.5 C1762.2,560.8,1806,455.3,1806,332z M2318,1164c0,34.7-12.7,64.7-38,90s-55.3,38-90,38c-36,0-66-12.7-90-38l-343-342 c-119.3,82.7-252.3,124-399,124c-95.3,0-186.5-18.5-273.5-55.5s-162-87-225-150s-113-138-150-225S654,427.3,654,332 s18.5-186.5,55.5-273.5s87-162,150-225s138-113,225-150S1262.7-372,1358-372s186.5,18.5,273.5,55.5s162,87,225,150s113,138,150,225 S2062,236.7,2062,332c0,146.7-41.3,279.7-124,399l343,343C2305.7,1098.7,2318,1128.7,2318,1164z"></path> 430 </svg> 431</div> 432<!-- Initialize autocomplete menu -->
433<script> 434$( "#aa-subject-input" ).keydown(function(e) { 435 e = e || window.event; 436 if (!hrefChanged && (e.keyCode || e.which) == 13) { 437 // Enter key pressed 438 window.location.href = "/docs/search.html?q=" + $( "#aa-subject-search-input" ).val().replace(' ', '+'); 439 } 440}); 441 442var client = algoliasearch('SELDDHION6', 'b9112b0485d58729c3e7c7b64291cbd9'); 443var index = client.initIndex('asciidocsy-topics'); 444// Initialize autocomplete on search input (ID selector must match). 445autocomplete('#aa-subject-search-input', 446{ hint: true, autoselect: false }, { 447 source: autocomplete.sources.hits(index, {hitsPerPage: 5, typoTolerance: 'false', advancedSyntax: 'true'}), 448 // Value to be displayed in input control after user's suggestion selection. 449 displayKey: function(suggestion) { 450 var titleValue; 451 if (suggestion.title) { 452 titleValue = suggestion.title; 453 } else { 454 var idx = suggestion.slug.lastIndexOf("_"); 455 titleValue = suggestion.slug.substring(idx + 1).replace(/-/g, " "); 456 titleValue = titleValue.charAt(0).toUpperCase() + titleValue.slice(1); 457 } 458 459 return titleValue; 460 }, 461 // Hash of templates used when rendering dataset. 462 templates: { 463 empty: function(suggestion) { 464 // Add the see more results option when no suggestion is found...
465 // just in case the user prefers to search in the main search page. 466 var hrefValue = "/search?q=" + document.getElementById('aa-subject-search-input').value.replace(' ', '+'); 467 return '<div class="aa-suggestion" role="option"><a id="show-more-link" class="suggestion-link" href="' + hrefValue + '">See more results...</a></div><div class="algolia-credit"><a href="https://www.algolia.com"><img src="/assets/images/search-by-algolia-light-background.svg"></div>'; 468 }, 469 footer: function(suggestion) { 470 // If no result is returned, don't add the show more results option 471 // cause it is added in the empty callback. 472 if (suggestion.isEmpty){ 473 return; 474 } 475 var hrefValue = "/search?q=" + document.getElementById('aa-subject-search-input').value.replace(' ', '+'); 476 return '<div class="aa-suggestion" role="option"><a id="show-more-link" class="suggestion-link" href="' + hrefValue + '">See more results...</a></div><div class="algolia-credit"><a href="https://www.algolia.com"><img src="/assets/images/search-by-algolia-light-background.svg"></div>'; 477 }, 478 // 'suggestion' templating function used to render a single suggestion. 479 suggestion: function(suggestion) { 480 // Only preview the first 200 characters of the page. 481 var contentValue = ""; 482 if (suggestion._highlightResult.content) { 483 contentValue = suggestion._highlightResult.content.value 484 if (suggestion._highlightResult.content.value.length > 200) { 485 contentValue = suggestion._highlightResult.content.value.slice(0, 200) + '...' 486 } 487 } 488 489 // Add a title based on the link to the pages that don't have 490 // a title. The title will get the link's last underscore and 491 // then get the following words... usually that is the name of the page. 492 var titleValue; 493 if (suggestion.title) { 494 titleValue = suggestion.title; 495 } else { 496 var idx = suggestion.slug.lastIndexOf("_"); 497 titleValue = suggestion.slug.substring(idx + 1).replace(/-/g, " "); 498 titleValue = titleValue.charAt(0).toUpperCase() + titleValue.slice(1); 499 } 500 501 // Define target link. 502 var linkValue = window.location.href.substring(0, window.location.href.indexOf('') - 1) + suggestion.url; 503 504 return '<a class="suggestion-link" href="' + linkValue + '"><span>' + titleValue + '</span><span>' + 505 contentValue + '</span></a>'; 506 } 507 } 508}).on('autocomplete:selected', function(event, suggestion, dataset) { 509 if (event._args.length > 0) { 510 var linkValue; 511 if (suggestion) { 512 linkValue = window.location.href.substring(0, window.location.href.indexOf('') - 1) + suggestion.url; 513 } else { 514 // Show more results. 515 linkValue = "search.html?q=" + document.getElementById('aa-subject-search-input').value.replace(' ', '+'); 516 } 517 window.location.href = linkValue; 518 hrefChanged = true; 519 } 520}); 521</script>
521 522 523 524 </div> 525 <div class="sidebar-mid"> 526 527 528 529 530 531 532 533 534 535 536 537 <!-- NAVGOCO menu component --> 538<ul id="subject-menu" class="nav flex-column"> 539 540 541 542 543 544 545 546 547 548 549 550 551 <li class="nav-item open card tier-1 parent "> 552 <a href="/docs/theme" class=" "> 553 AsciiDocsy Theme Docs 554 </a> 555 <!-- tag::sample-nesting[] --> 556 557 <ul> 558 559 560 561 562 563 564 565 566 567 568 569 570 <li class="nav-item tier-2 parent "> 571 <a href="/docs/theme/setup" class="nav-link "> 572 Getting Started 573 </a> 574 575 <ul> 576 577 578 579 580 581 582 583 584 585 586 587 588 <li class="nav-item tier-3 "> 589 <a href="/docs/theme/setup/environment" class="nav-link ">Writing/Dev Environment</a> 590 591 </li> 592 593 594 595 596 597 598 599 600 601 602 603 604 <li class="nav-item tier-3 "> 605 <a href="/docs/theme/setup/quickstart" class="nav-link ">Quickstart (Install & Build)</a> 606 607 </li> 608 609 610 611 612 613 614 615 616 617 618 619 620 <li class="nav-item tier-3 "> 621 <a href="/docs/theme/setup/bootstrap" class="nav-link ">Bootstrapping AsciiDocsy</a> 622 623 </li> 624 625 </ul> 626 627 </li> 628 629 630 631 632 633 634 635 636 637 638 639 640 <li class="nav-item tier-2 "> 641 <a href="/docs/theme/features/frontend" class="nav-link "> 642 Frontend Features Overview 643 </a> 644 645 </li> 646 647 648 649 650 651 652 653 654 655 656 657 658 <li class="nav-item tier-2 parent "> 659 <a href="/docs/theme/config" class="nav-link "> 660 Customize the Theme 661 </a> 662 663 <ul> 664 665 666 667 668 669 670 671 672 673 674 675 676 <li class="nav-item tier-3 "> 677 <a href="/docs/theme/config/api-reference" class="nav-link ">Config API Reference</a> 678 679 </li> 680 681 682 683 684 685 686 687 688 689 690 691 692 <li class="nav-item tier-3 parent "> 693 <a href="/docs/theme/config/search" class="nav-link ">Configure Search</a> 694 695 <ul> 696 697 698 699 700 701 702 703 704 705 706 707 708 <li class="nav-item tier-4 "> 709 <a href="/docs/theme/config/search/algolia" class="nav-link ">Algolia Search</a> 710 </li> 711 712 </ul> 713 714 </li> 715 716 717 718 719 720 721 722 723 724 725 726 727 <li class="nav-item tier-3 parent "> 728 <a href="/docs/theme/config/versioning" class="nav-link ">Version Handlers</a> 729 730 <ul> 731 732 733 734 735 736 737 738 739 740 741 742 743 <li class="nav-item tier-4 "> 744 <a href="/docs/theme/config/versioning/tabsets" class="nav-link ">Pane Tabs</a> 745 </li> 746 747 748 749 750 751 752 753 754 755 756 757 758 <li class="nav-item tier-4 "> 759 <a href="/docs/theme/config/versioning/toggles" class="nav-link ">Class Toggles</a> 760 </li> 761 762 763 764 765 766 767 768 769 770 771 772 773 <li class="nav-item tier-4 "> 774 <a href="/docs/theme/config/versioning/swaps" class="nav-link ">Token Swaps</a> 775 </li> 776 777 778 779 780 781 782 783 784 785 786 787 788 <li class="nav-item tier-4 "> 789 <a href="/docs/theme/config/versioning/amenders" class="nav-link ">DOM Amenders</a> 790 </li> 791 792 </ul> 793 794 </li> 795 796 797 798 799 800 801 802 803 804 805 806 807 <li class="nav-item tier-3 "> 808 <a href="/docs/theme/config/semantics" class="nav-link ">Customize Semantics</a> 809 810 </li> 811 812 </ul> 813 814 </li> 815 816 817 818 819 820 821 822 823 824 825 826 827 <li class="nav-item tier-2 "> 828 <a href="/docs/theme/extend" class="nav-link "> 829 Extend the Theme 830 </a> 831 832 </li> 833 834 835 836 837 838 839 840 841 842 843 844 845 <li class="nav-item tier-2 "> 846 <a href="/docs/theme/advanced" class="nav-link "> 847 Advanced Applications 848 </a> 849 850 </li> 851 852 853 854 855 856 857 858 859 860 861 862 863 <li class="nav-item tier-2 "> 864 <a href="/docs/theme/history" class="nav-link "> 865 Release History 866 </a> 867 868 </li> 869 870 </ul> 871 872 <!-- end::sample-nesting[] --> 873 </li> 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 <li class="nav-item open card tier-1 parent "> 889 <a href="/docs/style" class=" "> 890 Docs-as-Code Style Guides 891 </a> 892 <!-- tag::sample-nesting[] --> 893 894 <ul> 895 896 897 898 899 900 901 902 903 904 905 906 907 <li class="nav-item tier-2 parent "> 908 <a href="/docs/style/asciidoc" class="nav-link "> 909 AsciiDoc 910 </a> 911 912 <ul> 913 914 915 916 917 918 919 920 921 922 923 924 925 <li class="nav-item tier-3 "> 926 <a href="/docs/style/asciidoc/semantics" class="nav-link ">Inline Semantics</a> 927 928 </li> 929 930 </ul> 931 932 </li> 933 934 935 936 937 938 939 940 941 942 943 944 945 <li class="nav-item tier-2 "> 946 <a href="/docs/style/yaml" class="nav-link "> 947 YAML 948 </a> 949 950 </li> 951 952 953 954 955 956 957 958 959 960 961 962 963 <li class="nav-item tier-2 "> 964 <a href="/docs/style/liquid" class="nav-link "> 965 Liquid 966 </a> 967 968 </li> 969 970 </ul> 971 972 <!-- end::sample-nesting[] --> 973 </li> 974 975 976 977</ul> 978 979 </div> 980 <div class="sidebar-end"> 981 982 983 984 985 986 987 988 989 990 991 992 </div> 993 </div><!-- /.sticky-top --> 994 </div><!-- /#sidebar-left --> 995 996 <main id="main" class="col-12 col-md-9 col-xl-8 pl-md-5" role="main"> 997 <div class="td-content"> 998 <!-- --> 999 1000 1001<div id="breadcrumbs"> 1002<a href="/">Home</a> 1003 1004 1005 / AsciiDocsy Documentation 1006 1007 1008</div> 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
1021 1022 1023 1024 1025 1026<h1>AsciiDocsy Documentation</h1> 1027<div class="paragraph"> 1028<p>This website serves two roles. 1029It both <em>exemplifies</em> and <em>documents</em> the AsciiDocsy theme for Jekyll.</p> 1030</div> 1031<div class="paragraph"> 1032<p>The AsciiDocsy documentation is broken into two domains.</p> 1033</div> 1034<div class="paragraph"> 1035<p>The <a href="/docs/theme">AsciiDocsy Theme Docs</a> instruct working with this particular codebase. 1036These topics are pretty essential to getting AsciiDocsy working.</p> 1037</div> 1038<div class="paragraph"> 1039<p>Much more optional is the <a href="/docs/style">Docs-as-Code Style Guide</a>, presently covering <a href="/docs/style/asciidoc">AsciiDoc</a> content markup, <a href="/docs/style/yaml/">YAML</a> data markup, and <a href="/docs/style/liquid">Liquid</a> templating markup. 1040These guides may get a canonical home elsewhere, but for now I’m sourcing it right in this repo.</p> 1041</div> 1042<div class="row flex topic-footer"> 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 <!-- feedback form --> 1067 1068 1069<style> 1070 .feedback--answer { 1071 display: inline-block; 1072 } 1073 .feedback--response { 1074 display: none; 1075 margin-top: 1em; 1076 } 1077 .feedback--response__visible { 1078 display: block; 1079 } 1080</style> 1081<div class="jumbotron col-sm-4"> 1082<i class="icon fa fa-clipboard fa-4x float-right" style="margin-top: .5em;"></i> 1083<div class="h5">Feedback, please.</div> 1084<p class="feedback--question">Did you find this page helpful?</p> 1085<form method='POST' name='feedback'><input type='hidden' name='form-name' value='feedback' /> 1086 1087 <button type="button" class="btn btn-sm btn-secondary feedback--answer feedback--answer-yes">Yes</button> 1088 1089 <button type="button" class="btn btn-sm btn-secondary feedback--answer feedback--answer-no">No</button> 1090 1091 <button type="button" class="btn btn-sm btn-secondary feedback--answer feedback--answer-some">Partly</button> 1092 1093</form> 1094</div> 1095<div class="feedback--response feedback--response-"></div>
1096<script> 1097 1098 const yesButton = document.querySelector('.feedback--answer-yes'); 1099 const yesResponse = document.querySelector('.feedback--response-yes'); 1100 1101 const noButton = document.querySelector('.feedback--answer-no'); 1102 const noResponse = document.querySelector('.feedback--response-no'); 1103 1104 const someButton = document.querySelector('.feedback--answer-some'); 1105 const someResponse = document.querySelector('.feedback--response-some'); 1106 1107 const disableButtons = () => { 1108 1109 yesButton.disabled = true; 1110 1111 noButton.disabled = true; 1112 1113 someButton.disabled = true; 1114 1115 }; 1116 const sendFeedback = (value) => { 1117 if (typeof ga !== 'function') return; 1118 const args = { 1119 command: 'send', 1120 hitType: 'event', 1121 category: 'Helpful', 1122 action: 'click', 1123 label: window.location.pathname, 1124 value: value 1125 }; 1126 ga(args.command, args.hitType, args.category, args.action, args.label, args.value); 1127 }; 1128 1129 yesButton.addEventListener('click', () => { 1130 yesResponse.classList.add('feedback--response__visible'); 1131 disableButtons(); 1132 sendFeedback(1); 1133 }); 1134 1135 noButton.addEventListener('click', () => { 1136 noResponse.classList.add('feedback--response__visible'); 1137 disableButtons(); 1138 sendFeedback(1); 1139 }); 1140 1141 someButton.addEventListener('click', () => { 1142 someResponse.classList.add('feedback--response__visible'); 1143 disableButtons(); 1144 sendFeedback(1); 1145 }); 1146 1147</script>
1147 1148 1149 1150 1151</div> 1152 1153 </div> 1154 </main> 1155 1156 <div id="sidebar-right" class="d-none d-xl-block col-xl-2 td-toc d-print-none"><!-- TOPIC/PAGE REF/NAV --> 1157 <div class="sidebar-top"> 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 <div class="td-page-meta ml-2 pb-1 pt-2 mb-0"> 1170 <!-- --> 1171 1172<ul id="page-interactions" class="nav flex-column"> 1173 1174 1175 1176 1177 1178 1179 1180 1181 <li class="nav-item nav-item-peel"> 1182 <a href="#" class="nav-link"><i class="icon fa fa-newspaper-o fa-fw"></i> Print-friendly</a> 1183 </li> 1184 1185
1185<script> 1186 1187 $('.nav-item-peel .nav-link').click(function() { 1188 $('#sidebar-left').toggleClass('hide') 1189 $('header').toggleClass('hide') 1190 $('#sidebar-right').toggleClass('hide') 1191 $('footer').toggleClass('hide') 1192 }); 1193 1194 </script>
1194 1195 1196 1197 1198 1199 1200 <li class="nav-item nav-item-edit"> 1201 <a href="#" class="nav-link"><i class="icon fa fa-pencil-square fa-fw"></i> Edit this topic</a> 1202 </li> 1203 1204
1204<script> 1205 1206 // TODO: This will get moved into distinct function 1207 // with apologies for the bad JS... 1208 var feat = 'edit'; 1209 if (feat == 'edit') { 1210 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/edit/main/content/topics/intro.adoc"; 1211 } else if (feat == 'make') { 1212 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/new/main"; 1213 } else if (feat == 'data') { 1214 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/edit/main/"; 1215 } else if (feat == 'open-subj') { 1216 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/issues/new"; 1217 } else if (feat == 'open-docs') { 1218 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/issues/new?labels=documentation"; 1219 }; 1220 $('.nav-item-edit .nav-link').each(function() { 1221 $(this).attr('href', url); 1222 }); 1223 1224 </script>
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 <li class="nav-item nav-item-make"> 1235 <a href="#" class="nav-link"><i class="icon fa fa-file-text-o fa-fw"></i> Create a (sub)topic</a> 1236 </li> 1237 1238
1238<script> 1239 1240 // TODO: This will get moved into distinct function 1241 // with apologies for the bad JS... 1242 var feat = 'make'; 1243 if (feat == 'edit') { 1244 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/edit/main/content/topics/intro.adoc"; 1245 } else if (feat == 'make') { 1246 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/new/main"; 1247 } else if (feat == 'data') { 1248 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/edit/main/"; 1249 } else if (feat == 'open-subj') { 1250 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/issues/new"; 1251 } else if (feat == 'open-docs') { 1252 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/issues/new?labels=documentation"; 1253 }; 1254 $('.nav-item-make .nav-link').each(function() { 1255 $(this).attr('href', url); 1256 }); 1257 1258 </script>
1258 1259 1260 1261 1262 1263 1264 <li class="nav-item nav-item-open-docs"> 1265 <a href="#" class="nav-link"><i class="icon fa fa-ticket fa-fw"></i> Open a docs ticket.</a> 1266 </li> 1267 1268
1268<script> 1269 1270 // TODO: This will get moved into distinct function 1271 // with apologies for the bad JS... 1272 var feat = 'open-docs'; 1273 if (feat == 'edit') { 1274 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/edit/main/content/topics/intro.adoc"; 1275 } else if (feat == 'make') { 1276 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/new/main"; 1277 } else if (feat == 'data') { 1278 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/edit/main/"; 1279 } else if (feat == 'open-subj') { 1280 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/issues/new"; 1281 } else if (feat == 'open-docs') { 1282 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/issues/new?labels=documentation"; 1283 }; 1284 $('.nav-item-open-docs .nav-link').each(function() { 1285 $(this).attr('href', url); 1286 }); 1287 1288 </script>
1288 1289 1290 1291 1292 1293 1294 <li class="nav-item nav-item-open-subj"> 1295 <a href="#" class="nav-link"><i class="icon fa fa-tag fa-fw"></i> Open a product ticket.</a> 1296 </li> 1297 1298
1298<script> 1299 1300 // TODO: This will get moved into distinct function 1301 // with apologies for the bad JS... 1302 var feat = 'open-subj'; 1303 if (feat == 'edit') { 1304 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/edit/main/content/topics/intro.adoc"; 1305 } else if (feat == 'make') { 1306 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/new/main"; 1307 } else if (feat == 'data') { 1308 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/edit/main/"; 1309 } else if (feat == 'open-subj') { 1310 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/issues/new"; 1311 } else if (feat == 'open-docs') { 1312 var url = "https://github.com/DocOps/asciidocsy-jekyll-theme/issues/new?labels=documentation"; 1313 }; 1314 $('.nav-item-open-subj .nav-link').each(function() { 1315 $(this).attr('href', url); 1316 }); 1317 1318 </script>
1318 1319 1320 1321</ul> 1322 1323 1324 </div> 1325 </div> 1326 <div class="sidebar-mid"> 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 <nav id="toc-side" data-spy="affix" data-toggle="toc"></nav> 1340 1341 </div> 1342 <div class="sidebar-end"> 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381<!-- handler: 1 (theme-skin-amend) --> 1382 1383 1384<div class="form-group"> 1385 1386 <label for="theme-skin-amend"> 1387 1388 <i class="icon fa fa-paint-brush"></i> 1389 1390 Theme skin: 1391 </label> 1392 1393 <select class="form-control" id="theme-skin-amend"> 1394 1395 1396 1397 1398 <option value="colony">colony</option> 1399 1400 1401 1402 1403 <option value="foundation">foundation</option> 1404 1405 1406 1407 1408 <option value="foundation-lime">foundation-lime</option> 1409 1410 1411 1412 1413 <option value="foundation-potion">foundation-potion</option> 1414 1415 1416 1417 1418 <option value="github">github</option> 1419 1420 1421 1422 1423 <option value="golo">golo</option> 1424 1425 1426 1427 1428 <option value="maker">maker</option> 1429 1430 1431 1432 1433 <option value="readthedocs">readthedocs</option> 1434 1435 1436 1437 1438 <option value="riak">riak</option> 1439 1440 1441 1442 1443 <option value="rocket-panda">rocket-panda</option> 1444 1445 1446 1447 1448 <option value="rubygems">rubygems</option> 1449 1450 </select> 1451</div> 1452 1453 1454
1455<script type="text/javascript"> 1456 1457 1458const urlParams = new URLSearchParams(window.location.search); 1459 1460 1461/** 1462DOM AMENDER 1463**/ 1464$(function(){ 1465 $('select#theme-skin-amend').on('change', function () { 1466 1467 1468 /** 1469 STYLE CHANGER 1470 **/ 1471 var newStyleSheet = '/assets/css/skins/' + $(this).val() + '.css' 1472 $('#theme-skin').attr("href", newStyleSheet) 1473 $.cookie('theme-skin-amend', $(this).val()); 1474 1475 1476 1477 }); 1478}); 1479 1480 1481/** 1482Set value on page load 1483Priority order: 1484 1. URL query string parameter 1485 2. cookie parameter 1486 3. default value from `pick:` property 1487 4. first option listed 1488**/ 1489$( document ).ready(function() { 1490 var nochoice = false; 1491 if ( urlParams.has('theme-skin-amend') ) { 1492 var val = urlParams.get('theme-skin-amend') 1493 } else if ( $.cookie('theme-skin-amend') ) { 1494 var val = ($.cookie('theme-skin-amend')) 1495 } else if ( 'foundation' != '' ) { 1496 var val = "foundation" 1497 } else { 1498 nochoice = true; 1499 } 1500 1501 if (nochoice) { var val = $('#theme-skin-amend option:first-child').val() } 1502 $('#theme-skin-amend').val(val).change(); 1503 1504 $.cookie('theme-skin-amend', val); 1505}); 1506 1507</script>
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545<!-- handler: 2 (syntax-skin-amend) --> 1546 1547 1548<div class="form-group"> 1549 1550 <label for="syntax-skin-amend"> 1551 1552 <i class="icon fa fa-code"></i> 1553 1554 Code highlight skin: 1555 </label> 1556 1557 <select class="form-control" id="syntax-skin-amend"> 1558 1559 1560 1561 1562 <option value="a11y-dark">a11y-dark</option> 1563 1564 1565 1566 1567 <option value="a11y-light">a11y-light</option> 1568 1569 1570 1571 1572 <option value="agate">agate</option> 1573 1574 1575 1576 1577 <option value="androidstudio">androidstudio</option> 1578 1579 1580 1581 1582 <option value="an-old-hope">an-old-hope</option> 1583 1584 1585 1586 1587 <option value="arduino-light">arduino-light</option> 1588 1589 1590 1591 1592 <option value="arta">arta</option> 1593 1594 1595 1596 1597 <option value="ascetic">ascetic</option> 1598 1599 1600 1601 1602 <option value="atelier-cave-dark">atelier-cave-dark</option> 1603 1604 1605 1606 1607 <option value="atelier-cave-light">atelier-cave-light</option> 1608 1609 1610 1611 1612 <option value="atelier-dune-dark">atelier-dune-dark</option> 1613 1614 1615 1616 1617 <option value="atelier-dune-light">atelier-dune-light</option> 1618 1619 1620 1621 1622 <option value="atelier-estuary-dark">atelier-estuary-dark</option> 1623 1624 1625 1626 1627 <option value="atelier-estuary-light">atelier-estuary-light</option> 1628 1629 1630 1631 1632 <option value="atelier-forest-dark">atelier-forest-dark</option> 1633 1634 1635 1636 1637 <option value="atelier-forest-light">atelier-forest-light</option> 1638 1639 1640 1641 1642 <option value="atelier-heath-dark">atelier-heath-dark</option> 1643 1644 1645 1646 1647 <option value="atelier-heath-light">atelier-heath-light</option> 1648 1649 1650 1651 1652 <option value="atelier-lakeside-dark">atelier-lakeside-dark</option> 1653 1654 1655 1656 1657 <option value="atelier-lakeside-light">atelier-lakeside-light</option> 1658 1659 1660 1661 1662 <option value="atelier-plateau-dark">atelier-plateau-dark</option> 1663 1664 1665 1666 1667 <option value="atelier-plateau-light">atelier-plateau-light</option> 1668 1669 1670 1671 1672 <option value="atelier-savanna-dark">atelier-savanna-dark</option> 1673 1674 1675 1676 1677 <option value="atelier-savanna-light">atelier-savanna-light</option> 1678 1679 1680 1681 1682 <option value="atelier-seaside-dark">atelier-seaside-dark</option> 1683 1684 1685 1686 1687 <option value="atelier-seaside-light">atelier-seaside-light</option> 1688 1689 1690 1691 1692 <option value="atelier-sulphurpool-dark">atelier-sulphurpool-dark</option> 1693 1694 1695 1696 1697 <option value="atelier-sulphurpool-light">atelier-sulphurpool-light</option> 1698 1699 1700 1701 1702 <option value="atom-one-dark">atom-one-dark</option> 1703 1704 1705 1706 1707 <option value="atom-one-dark-reasonable">atom-one-dark-reasonable</option> 1708 1709 1710 1711 1712 <option value="atom-one-light">atom-one-light</option> 1713 1714 1715 1716 1717 <option value="brown-paper">brown-paper</option> 1718 1719 1720 1721 1722 <option value="codepen-embed">codepen-embed</option> 1723 1724 1725 1726 1727 <option value="color-brewer">color-brewer</option> 1728 1729 1730 1731 1732 <option value="darcula">darcula</option> 1733 1734 1735 1736 1737 <option value="dark">dark</option> 1738 1739 1740 1741 1742 <option value="default">default</option> 1743 1744 1745 1746 1747 <option value="docco">docco</option> 1748 1749 1750 1751 1752 <option value="dracula">dracula</option> 1753 1754 1755 1756 1757 <option value="far">far</option> 1758 1759 1760 1761 1762 <option value="foundation">foundation</option> 1763 1764 1765 1766 1767 <option value="github">github</option> 1768 1769 1770 1771 1772 <option value="github-gist">github-gist</option> 1773 1774 1775 1776 1777 <option value="gml">gml</option> 1778 1779 1780 1781 1782 <option value="googlecode">googlecode</option> 1783 1784 1785 1786 1787 <option value="gradient-dark">gradient-dark</option> 1788 1789 1790 1791 1792 <option value="gradient-light">gradient-light</option> 1793 1794 1795 1796 1797 <option value="grayscale">grayscale</option> 1798 1799 1800 1801 1802 <option value="gruvbox-dark">gruvbox-dark</option> 1803 1804 1805 1806 1807 <option value="gruvbox-light">gruvbox-light</option> 1808 1809 1810 1811 1812 <option value="hopscotch">hopscotch</option> 1813 1814 1815 1816 1817 <option value="hybrid">hybrid</option> 1818 1819 1820 1821 1822 <option value="idea">idea</option> 1823 1824 1825 1826 1827 <option value="ir-black">ir-black</option> 1828 1829 1830 1831 1832 <option value="isbl-editor-dark">isbl-editor-dark</option> 1833 1834 1835 1836 1837 <option value="isbl-editor-light">isbl-editor-light</option> 1838 1839 1840 1841 1842 <option value="kimbie.dark">kimbie.dark</option> 1843 1844 1845 1846 1847 <option value="kimbie.light">kimbie.light</option> 1848 1849 1850 1851 1852 <option value="lightfair">lightfair</option> 1853 1854 1855 1856 1857 <option value="lioshi">lioshi</option> 1858 1859 1860 1861 1862 <option value="magula">magula</option> 1863 1864 1865 1866 1867 <option value="mono-blue">mono-blue</option> 1868 1869 1870 1871 1872 <option value="monokai">monokai</option> 1873 1874 1875 1876 1877 <option value="monokai-sublime">monokai-sublime</option> 1878 1879 1880 1881 1882 <option value="night-owl">night-owl</option> 1883 1884 1885 1886 1887 <option value="nnfx">nnfx</option> 1888 1889 1890 1891 1892 <option value="nnfx-dark">nnfx-dark</option> 1893 1894 1895 1896 1897 <option value="nord">nord</option> 1898 1899 1900 1901 1902 <option value="obsidian">obsidian</option> 1903 1904 1905 1906 1907 <option value="ocean">ocean</option> 1908 1909 1910 1911 1912 <option value="paraiso-dark">paraiso-dark</option> 1913 1914 1915 1916 1917 <option value="paraiso-light">paraiso-light</option> 1918 1919 1920 1921 1922 <option value="pojoaque">pojoaque</option> 1923 1924 1925 1926 1927 <option value="purebasic">purebasic</option> 1928 1929 1930 1931 1932 <option value="qtcreator_dark">qtcreator_dark</option> 1933 1934 1935 1936 1937 <option value="qtcreator_light">qtcreator_light</option> 1938 1939 1940 1941 1942 <option value="railscasts">railscasts</option> 1943 1944 1945 1946 1947 <option value="rainbow">rainbow</option> 1948 1949 1950 1951 1952 <option value="routeros">routeros</option> 1953 1954 1955 1956 1957 <option value="school-book">school-book</option> 1958 1959 1960 1961 1962 <option value="shades-of-purple">shades-of-purple</option> 1963 1964 1965 1966 1967 <option value="solarized-dark">solarized-dark</option> 1968 1969 1970 1971 1972 <option value="solarized-light">solarized-light</option> 1973 1974 1975 1976 1977 <option value="srcery">srcery</option> 1978 1979 1980 1981 1982 <option value="stackoverflow-dark">stackoverflow-dark</option> 1983 1984 1985 1986 1987 <option value="stackoverflow-light">stackoverflow-light</option> 1988 1989 1990 1991 1992 <option value="sunburst">sunburst</option> 1993 1994 1995 1996 1997 <option value="tomorrow">tomorrow</option> 1998 1999 2000 2001 2002 <option value="tomorrow-night-blue">tomorrow-night-blue</option> 2003 2004 2005 2006 2007 <option value="tomorrow-night-bright">tomorrow-night-bright</option> 2008 2009 2010 2011 2012 <option value="tomorrow-night">tomorrow-night</option> 2013 2014 2015 2016 2017 <option value="tomorrow-night-eighties">tomorrow-night-eighties</option> 2018 2019 2020 2021 2022 <option value="vs2015">vs2015</option> 2023 2024 2025 2026 2027 <option value="vs">vs</option> 2028 2029 2030 2031 2032 <option value="xcode">xcode</option> 2033 2034 2035 2036 2037 <option value="xt256">xt256</option> 2038 2039 2040 2041 2042 <option value="zenburn">zenburn</option> 2043 2044 </select> 2045</div> 2046 2047 2048
2049<script type="text/javascript"> 2050 2051 2052/** 2053DOM AMENDER 2054**/ 2055$(function(){ 2056 $('select#syntax-skin-amend').on('change', function () { 2057 2058 2059 /** 2060 STYLE CHANGER 2061 **/ 2062 var newStyleSheet = '/assets/css/syntax/hljs/' + $(this).val() + '.css' 2063 $('#syntax-skin').attr("href", newStyleSheet) 2064 $.cookie('syntax-skin-amend', $(this).val()); 2065 2066 2067 2068 }); 2069}); 2070 2071 2072/** 2073Set value on page load 2074Priority order: 2075 1. URL query string parameter 2076 2. cookie parameter 2077 3. default value from `pick:` property 2078 4. first option listed 2079**/ 2080$( document ).ready(function() { 2081 var nochoice = false; 2082 if ( urlParams.has('syntax-skin-amend') ) { 2083 var val = urlParams.get('syntax-skin-amend') 2084 } else if ( $.cookie('syntax-skin-amend') ) { 2085 var val = ($.cookie('syntax-skin-amend')) 2086 } else if ( 'a11y-light' != '' ) { 2087 var val = "a11y-light" 2088 } else { 2089 nochoice = true; 2090 } 2091 2092 if (nochoice) { var val = $('#syntax-skin-amend option:first-child').val() } 2093 $('#syntax-skin-amend').val(val).change(); 2094 2095 $.cookie('syntax-skin-amend', val); 2096}); 2097 2098</script>
2098 2099 2100 2101 2102 2103 2104 </div> 2105 </div><!-- /#sidebar-right --> 2106 2107 </div><!-- /.row.flex-xl-nowrap --> 2108 </div><!-- /.td-main --> 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125<footer class="row flex-xl-nowrap"><!-- COMPANY REF/NAV --> 2126 <div class="container-fluid"> 2127 <div class="row"> 2128 <div class="col-md-4"> 2129 2130 <span class="company-logo"> 2131 <img src="/assets/images/docops-labs-logo.png" class="logo" width="150px"> 2132 </span> 2133 2134 2135 <div class="footer-title h4">DocOps Labs</div> 2136 2137 2138 <div class="footer-title h5">Your HQ for documentation tooling and workflows.</div> 2139 2140 <div>/assets/js/tail.js</div> 2141 2142 </div> 2143 2144 2145 2146 <div class="col-md-2 offset-2"> 2147 <ul class="list-unstyled"> 2148 <li class="footer-heading h5">About</li> 2149 2150 2151 <li><a href="/about" data-toggle="tooltip" title="AsciiDocsy Backstory">AsciiDocsy Backstory</a></li> 2152 2153 2154 <li><a href="/contributing" data-toggle="tooltip" title="Contributing">Contributing</a></li> 2155 2156 2157 <li><a href="/readme" data-toggle="tooltip" title="README">README</a></li> 2158 2159 2160 <li><a href="https://github.com/DocOps/asciidocsy-jekyll-theme" data-toggle="tooltip" title="Source">Source</a></li> 2161 2162 </ul> 2163 </div> 2164 2165 2166 2167 <div class="col-md-2 "> 2168 <ul class="list-unstyled"> 2169 <li class="footer-heading h5">Resources</li> 2170 2171 2172 <li><a href="https://www.codewriting.org" data-toggle="tooltip" title="Codewriting">Codewriting</a></li> 2173 2174 2175 <li><a href="https://www.writethedocs.org" data-toggle="tooltip" title="Write the Docs">Write the Docs</a></li> 2176 2177 2178 <li><a href="https://asciidoctor.zulipchat.com/login/" data-toggle="tooltip" title="Asciidoctor Chat">Asciidoctor Chat</a></li> 2179 2180 </ul> 2181 </div> 2182 2183 2184 2185 <div class="col-md-2 "> 2186 <ul class="list-unstyled"> 2187 <li class="footer-heading h5">Upstream</li> 2188 2189 2190 <li><a href="https://www.asciidoctor.org" data-toggle="tooltip" title="THE AsciiDoc markup converter">Asciidoctor</a></li> 2191 2192 2193 <li><a href="https://jekyllrb.com" data-toggle="tooltip" title="world-class static-site generator (SSG)">Jekyll</a></li> 2194 2195 2196 <li><a href="https://shopify.github.io/liquid/" data-toggle="tooltip" title="Shopify's fierce templating lang & engine">Liquid</a></li> 2197 2198 2199 <li><a href="https://getbootstrap.com" data-toggle="tooltip" title="premiere HTML/CSS/JS framework">Bootstrap</a></li> 2200 2201 2202 <li><a href="https://jquery.com" data-toggle="tooltip" title="JavaScript framework">jQuery</a></li> 2203 2204 2205 <li><a href="https://fontawesome.com" data-toggle="tooltip" title="simple, elegant icons as a typeface">FontAwesome</a></li> 2206 2207 </ul> 2208 </div> 2209 2210 </div> 2211 2212 <div class="row justify-content-md-center"> 2213 <div class="footer-strings col-md-8 text-center"> 2214 2215 <div class="copyright"> 2216 <p><div class="paragraph"> 2217<p>© 2021 Copyright Codewriting LLC & upstream authors</p> 2218</div></p> 2219 </div> 2220 2221 2222 <div class="madewith"> 2223 <p><div class="paragraph"> 2224<p>Sourced in AsciiDoc and YAML. Generated with Jekyll, Asciidoctor, and AsciiDocsy.</p> 2225</div></p> 2226 </div> 2227 2228 </div> 2229 </div> 2230 2231 2232 2233 2234 2235 2236 2237</footer> 2238 2239 2240 </div><!-- /.container-fluid.td-outer --> 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250
2251<script src="/assets/js/tail.js" integrity="" crossorigin="anonymous"></script>
2251 2252 2253
2254<script> 2255// invoke anchor.js 2256anchors.add('h2,h3,h4,h5'); 2257</script>
2257 2258 2259 2260 2261 2262 2263 2264 2265</body> 2266</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.