Also edited the README to reflect the new build procedure.
Signed-off-by: blake <blake@mobiusconsortium.org>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
[source,bash]
----
$ git clone git://git.evergreen-ils.org/working/Evergreen.git
+$ git clone git://git.evergreen-ils.org/eg-antora.git
$ cd Evergreen
$ git checkout collab/blake/LP1848524_antora_ize_docs
----
[source,bash]
----
-$ cd ui
+$ cd ../../eg-antora
$ npm install
-$ gulp --tasks-simple
-$ gulp bundle
+$ npm gulp-bundle
----
At this point you should find a file in:
[source,bash]
----
-$ cd ..
+$ cd ../Evergreen/docs-antora
antora site.yml
----
start_path: docs-antora
ui:
bundle:
- url: ./ui/build/ui-bundle.zip
+ url: ./../../eg-antora/build/ui-bundle.zip
supplemental_files: ./ui/ui-lunr
output:
+++ /dev/null
-Mozilla Public License Version 2.0
-==================================
-
-1. Definitions
---------------
-
-1.1. "Contributor"
- means each individual or legal entity that creates, contributes to
- the creation of, or owns Covered Software.
-
-1.2. "Contributor Version"
- means the combination of the Contributions of others (if any) used
- by a Contributor and that particular Contributor's Contribution.
-
-1.3. "Contribution"
- means Covered Software of a particular Contributor.
-
-1.4. "Covered Software"
- means Source Code Form to which the initial Contributor has attached
- the notice in Exhibit A, the Executable Form of such Source Code
- Form, and Modifications of such Source Code Form, in each case
- including portions thereof.
-
-1.5. "Incompatible With Secondary Licenses"
- means
-
- (a) that the initial Contributor has attached the notice described
- in Exhibit B to the Covered Software; or
-
- (b) that the Covered Software was made available under the terms of
- version 1.1 or earlier of the License, but not also under the
- terms of a Secondary License.
-
-1.6. "Executable Form"
- means any form of the work other than Source Code Form.
-
-1.7. "Larger Work"
- means a work that combines Covered Software with other material, in
- a separate file or files, that is not Covered Software.
-
-1.8. "License"
- means this document.
-
-1.9. "Licensable"
- means having the right to grant, to the maximum extent possible,
- whether at the time of the initial grant or subsequently, any and
- all of the rights conveyed by this License.
-
-1.10. "Modifications"
- means any of the following:
-
- (a) any file in Source Code Form that results from an addition to,
- deletion from, or modification of the contents of Covered
- Software; or
-
- (b) any new file in Source Code Form that contains any Covered
- Software.
-
-1.11. "Patent Claims" of a Contributor
- means any patent claim(s), including without limitation, method,
- process, and apparatus claims, in any patent Licensable by such
- Contributor that would be infringed, but for the grant of the
- License, by the making, using, selling, offering for sale, having
- made, import, or transfer of either its Contributions or its
- Contributor Version.
-
-1.12. "Secondary License"
- means either the GNU General Public License, Version 2.0, the GNU
- Lesser General Public License, Version 2.1, the GNU Affero General
- Public License, Version 3.0, or any later versions of those
- licenses.
-
-1.13. "Source Code Form"
- means the form of the work preferred for making modifications.
-
-1.14. "You" (or "Your")
- means an individual or a legal entity exercising rights under this
- License. For legal entities, "You" includes any entity that
- controls, is controlled by, or is under common control with You. For
- purposes of this definition, "control" means (a) the power, direct
- or indirect, to cause the direction or management of such entity,
- whether by contract or otherwise, or (b) ownership of more than
- fifty percent (50%) of the outstanding shares or beneficial
- ownership of such entity.
-
-2. License Grants and Conditions
---------------------------------
-
-2.1. Grants
-
-Each Contributor hereby grants You a world-wide, royalty-free,
-non-exclusive license:
-
-(a) under intellectual property rights (other than patent or trademark)
- Licensable by such Contributor to use, reproduce, make available,
- modify, display, perform, distribute, and otherwise exploit its
- Contributions, either on an unmodified basis, with Modifications, or
- as part of a Larger Work; and
-
-(b) under Patent Claims of such Contributor to make, use, sell, offer
- for sale, have made, import, and otherwise transfer either its
- Contributions or its Contributor Version.
-
-2.2. Effective Date
-
-The licenses granted in Section 2.1 with respect to any Contribution
-become effective for each Contribution on the date the Contributor first
-distributes such Contribution.
-
-2.3. Limitations on Grant Scope
-
-The licenses granted in this Section 2 are the only rights granted under
-this License. No additional rights or licenses will be implied from the
-distribution or licensing of Covered Software under this License.
-Notwithstanding Section 2.1(b) above, no patent license is granted by a
-Contributor:
-
-(a) for any code that a Contributor has removed from Covered Software;
- or
-
-(b) for infringements caused by: (i) Your and any other third party's
- modifications of Covered Software, or (ii) the combination of its
- Contributions with other software (except as part of its Contributor
- Version); or
-
-(c) under Patent Claims infringed by Covered Software in the absence of
- its Contributions.
-
-This License does not grant any rights in the trademarks, service marks,
-or logos of any Contributor (except as may be necessary to comply with
-the notice requirements in Section 3.4).
-
-2.4. Subsequent Licenses
-
-No Contributor makes additional grants as a result of Your choice to
-distribute the Covered Software under a subsequent version of this
-License (see Section 10.2) or under the terms of a Secondary License (if
-permitted under the terms of Section 3.3).
-
-2.5. Representation
-
-Each Contributor represents that the Contributor believes its
-Contributions are its original creation(s) or it has sufficient rights
-to grant the rights to its Contributions conveyed by this License.
-
-2.6. Fair Use
-
-This License is not intended to limit any rights You have under
-applicable copyright doctrines of fair use, fair dealing, or other
-equivalents.
-
-2.7. Conditions
-
-Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
-in Section 2.1.
-
-3. Responsibilities
--------------------
-
-3.1. Distribution of Source Form
-
-All distribution of Covered Software in Source Code Form, including any
-Modifications that You create or to which You contribute, must be under
-the terms of this License. You must inform recipients that the Source
-Code Form of the Covered Software is governed by the terms of this
-License, and how they can obtain a copy of this License. You may not
-attempt to alter or restrict the recipients' rights in the Source Code
-Form.
-
-3.2. Distribution of Executable Form
-
-If You distribute Covered Software in Executable Form then:
-
-(a) such Covered Software must also be made available in Source Code
- Form, as described in Section 3.1, and You must inform recipients of
- the Executable Form how they can obtain a copy of such Source Code
- Form by reasonable means in a timely manner, at a charge no more
- than the cost of distribution to the recipient; and
-
-(b) You may distribute such Executable Form under the terms of this
- License, or sublicense it under different terms, provided that the
- license for the Executable Form does not attempt to limit or alter
- the recipients' rights in the Source Code Form under this License.
-
-3.3. Distribution of a Larger Work
-
-You may create and distribute a Larger Work under terms of Your choice,
-provided that You also comply with the requirements of this License for
-the Covered Software. If the Larger Work is a combination of Covered
-Software with a work governed by one or more Secondary Licenses, and the
-Covered Software is not Incompatible With Secondary Licenses, this
-License permits You to additionally distribute such Covered Software
-under the terms of such Secondary License(s), so that the recipient of
-the Larger Work may, at their option, further distribute the Covered
-Software under the terms of either this License or such Secondary
-License(s).
-
-3.4. Notices
-
-You may not remove or alter the substance of any license notices
-(including copyright notices, patent notices, disclaimers of warranty,
-or limitations of liability) contained within the Source Code Form of
-the Covered Software, except that You may alter any license notices to
-the extent required to remedy known factual inaccuracies.
-
-3.5. Application of Additional Terms
-
-You may choose to offer, and to charge a fee for, warranty, support,
-indemnity or liability obligations to one or more recipients of Covered
-Software. However, You may do so only on Your own behalf, and not on
-behalf of any Contributor. You must make it absolutely clear that any
-such warranty, support, indemnity, or liability obligation is offered by
-You alone, and You hereby agree to indemnify every Contributor for any
-liability incurred by such Contributor as a result of warranty, support,
-indemnity or liability terms You offer. You may include additional
-disclaimers of warranty and limitations of liability specific to any
-jurisdiction.
-
-4. Inability to Comply Due to Statute or Regulation
----------------------------------------------------
-
-If it is impossible for You to comply with any of the terms of this
-License with respect to some or all of the Covered Software due to
-statute, judicial order, or regulation then You must: (a) comply with
-the terms of this License to the maximum extent possible; and (b)
-describe the limitations and the code they affect. Such description must
-be placed in a text file included with all distributions of the Covered
-Software under this License. Except to the extent prohibited by statute
-or regulation, such description must be sufficiently detailed for a
-recipient of ordinary skill to be able to understand it.
-
-5. Termination
---------------
-
-5.1. The rights granted under this License will terminate automatically
-if You fail to comply with any of its terms. However, if You become
-compliant, then the rights granted under this License from a particular
-Contributor are reinstated (a) provisionally, unless and until such
-Contributor explicitly and finally terminates Your grants, and (b) on an
-ongoing basis, if such Contributor fails to notify You of the
-non-compliance by some reasonable means prior to 60 days after You have
-come back into compliance. Moreover, Your grants from a particular
-Contributor are reinstated on an ongoing basis if such Contributor
-notifies You of the non-compliance by some reasonable means, this is the
-first time You have received notice of non-compliance with this License
-from such Contributor, and You become compliant prior to 30 days after
-Your receipt of the notice.
-
-5.2. If You initiate litigation against any entity by asserting a patent
-infringement claim (excluding declaratory judgment actions,
-counter-claims, and cross-claims) alleging that a Contributor Version
-directly or indirectly infringes any patent, then the rights granted to
-You by any and all Contributors for the Covered Software under Section
-2.1 of this License shall terminate.
-
-5.3. In the event of termination under Sections 5.1 or 5.2 above, all
-end user license agreements (excluding distributors and resellers) which
-have been validly granted by You or Your distributors under this License
-prior to termination shall survive termination.
-
-************************************************************************
-* *
-* 6. Disclaimer of Warranty *
-* ------------------------- *
-* *
-* Covered Software is provided under this License on an "as is" *
-* basis, without warranty of any kind, either expressed, implied, or *
-* statutory, including, without limitation, warranties that the *
-* Covered Software is free of defects, merchantable, fit for a *
-* particular purpose or non-infringing. The entire risk as to the *
-* quality and performance of the Covered Software is with You. *
-* Should any Covered Software prove defective in any respect, You *
-* (not any Contributor) assume the cost of any necessary servicing, *
-* repair, or correction. This disclaimer of warranty constitutes an *
-* essential part of this License. No use of any Covered Software is *
-* authorized under this License except under this disclaimer. *
-* *
-************************************************************************
-
-************************************************************************
-* *
-* 7. Limitation of Liability *
-* -------------------------- *
-* *
-* Under no circumstances and under no legal theory, whether tort *
-* (including negligence), contract, or otherwise, shall any *
-* Contributor, or anyone who distributes Covered Software as *
-* permitted above, be liable to You for any direct, indirect, *
-* special, incidental, or consequential damages of any character *
-* including, without limitation, damages for lost profits, loss of *
-* goodwill, work stoppage, computer failure or malfunction, or any *
-* and all other commercial damages or losses, even if such party *
-* shall have been informed of the possibility of such damages. This *
-* limitation of liability shall not apply to liability for death or *
-* personal injury resulting from such party's negligence to the *
-* extent applicable law prohibits such limitation. Some *
-* jurisdictions do not allow the exclusion or limitation of *
-* incidental or consequential damages, so this exclusion and *
-* limitation may not apply to You. *
-* *
-************************************************************************
-
-8. Litigation
--------------
-
-Any litigation relating to this License may be brought only in the
-courts of a jurisdiction where the defendant maintains its principal
-place of business and such litigation shall be governed by laws of that
-jurisdiction, without reference to its conflict-of-law provisions.
-Nothing in this Section shall prevent a party's ability to bring
-cross-claims or counter-claims.
-
-9. Miscellaneous
-----------------
-
-This License represents the complete agreement concerning the subject
-matter hereof. If any provision of this License is held to be
-unenforceable, such provision shall be reformed only to the extent
-necessary to make it enforceable. Any law or regulation which provides
-that the language of a contract shall be construed against the drafter
-shall not be used to construe this License against a Contributor.
-
-10. Versions of the License
----------------------------
-
-10.1. New Versions
-
-Mozilla Foundation is the license steward. Except as provided in Section
-10.3, no one other than the license steward has the right to modify or
-publish new versions of this License. Each version will be given a
-distinguishing version number.
-
-10.2. Effect of New Versions
-
-You may distribute the Covered Software under the terms of the version
-of the License under which You originally received the Covered Software,
-or under the terms of any subsequent version published by the license
-steward.
-
-10.3. Modified Versions
-
-If you create software not governed by this License, and you want to
-create a new license for such software, you may create and use a
-modified version of this License if you rename the license and remove
-any references to the name of the license steward (except to note that
-such modified license differs from this License).
-
-10.4. Distributing Source Code Form that is Incompatible With Secondary
-Licenses
-
-If You choose to distribute Source Code Form that is Incompatible With
-Secondary Licenses under the terms of this version of the License, the
-notice described in Exhibit B of this License must be attached.
-
-Exhibit A - Source Code Form License Notice
--------------------------------------------
-
- This Source Code Form is subject to the terms of the Mozilla Public
- License, v. 2.0. If a copy of the MPL was not distributed with this
- file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-If it is not possible or desirable to put the notice in a particular
-file, then You may include the notice in a location (such as a LICENSE
-file in a relevant directory) where a recipient would be likely to look
-for such a notice.
-
-You may add additional accurate notices of copyright ownership.
-
-Exhibit B - "Incompatible With Secondary Licenses" Notice
----------------------------------------------------------
-
- This Source Code Form is "Incompatible With Secondary Licenses", as
- defined by the Mozilla Public License, v. 2.0.
+++ /dev/null
-= Antora Default UI
-// Settings:
-:experimental:
-:hide-uri-scheme:
-// Project URLs:
-:url-project: https://gitlab.com/antora/antora-ui-default
-:url-preview: https://antora.gitlab.io/antora-ui-default
-:url-ci-pipelines: {url-project}/pipelines
-:img-ci-status: {url-project}/badges/master/pipeline.svg
-// External URLs:
-:url-antora: https://antora.org
-:url-antora-docs: https://docs.antora.org
-:url-git: https://git-scm.com
-:url-git-dl: {url-git}/downloads
-:url-gulp: http://gulpjs.com
-:url-opendevise: https://opendevise.com
-:url-nodejs: https://nodejs.org
-:url-nvm: https://github.com/creationix/nvm
-:url-nvm-install: {url-nvm}#installation
-
-image:{img-ci-status}[CI Status (GitLab CI), link={url-ci-pipelines}]
-
-This project is an archetype that demonstrates how to produce a UI bundle that can be used by {url-antora}[Antora] to generated a documentation site.
-You can see a preview of the default UI at {url-preview}.
-
-While the default UI is ready to be used with Antora, the intent is that you'll fork it and customize it for your own needs.
-It's intentionally minimalistic so as to give you a good starting point without requiring too much effort to customize.
-
-== Use the Default UI
-
-If you want to simply use the default UI for your Antora-generated site, add the following UI configuration to your playbook:
-
-[source,yaml]
-----
-ui:
- bundle:
- url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
- snapshot: true
-----
-
-NOTE: The `snapshot` flag tells Antora to fetch the UI when the `--fetch` command-line flag is present.
-This setting is required because updates to the UI bundle are pushed to the same URL.
-If the URL were to be unique, this setting would not be required.
-
-Read on to learn how to customize the default UI for your own documentation.
-
-== Development Quickstart
-
-This section offers a basic tutorial to teach you how to set up the default UI project, preview it locally, and bundle it for use with Antora.
-A more comprehensive can be found in the documentation at {url-antora-docs}.
-
-=== Prerequisites
-
-To preview and bundle the default UI, you need the following software on your computer:
-
-* {url-git}[git] (command: `git`)
-* {url-nodejs}[Node.js] (commands: `node` and `npm`)
-* {url-gulp}[Gulp CLI] (command: `gulp`)
-
-==== git
-
-First, make sure you have git installed.
-
- $ git --version
-
-If not, {url-git-dl}[download and install] the git package for your system.
-
-==== Node.js
-
-Next, make sure that you have Node.js installed (which also provides npm).
-
- $ node --version
-
-If this command fails with an error, you don't have Node.js installed.
-If the command doesn't report an LTS version of Node.js (e.g., v10.15.3), it means you don't have a suitable version of Node.js installed.
-In this guide, we'll be installing Node.js 10.
-
-While you can install Node.js from the official packages, we strongly recommend that you use {url-nvm}[nvm] (Node Version Manager) to manage your Node.js installation(s).
-Follow the {url-nvm-install}[nvm installation instructions] to set up nvm on your machine.
-
-Once you've installed nvm, open a new terminal and install Node.js 10 using the following command:
-
- $ nvm install 10
-
-You can switch to this version of Node.js at any time using the following command:
-
- $ nvm use 10
-
-To make Node.js 10 the default in new terminals, type:
-
- $ nvm alias default 10
-
-Now that you have Node.js installed, you can proceed with installing the Gulp CLI.
-
-==== Gulp CLI
-
-You'll need the Gulp command-line interface (CLI) to run the build.
-The Gulp CLI package provides the `gulp` command which, in turn, executes the version of Gulp declared by the project.
-
-You should install the Gulp CLI globally (which resolves to a location in your user directory if you're using nvm) using the following command:
-
- $ npm install -g gulp-cli
-
-Verify the Gulp CLI is installed and on your PATH by running:
-
- $ gulp --version
-
-[TIP]
-====
-If you prefer to install global packages using Yarn, run this command instead:
-
- $ yarn global add gulp-cli
-====
-
-Now that you have the prerequisites installed, you can fetch and build the UI project.
-
-=== Clone and Initialize the UI Project
-
-Clone the default UI project using git:
-
-[subs=attributes+]
- $ git clone {url-project} &&
- cd "`basename $_`"
-
-The example above clones Antora's default UI project and then switches to the project folder on your filesystem.
-Stay in this project folder when executing all subsequent commands.
-
-Use npm to install the project's dependencies inside the project.
-In your terminal, execute the following command:
-
- $ npm install
-
-This command installs the dependencies listed in [.path]_package.json_ into the [.path]_node_modules/_ folder inside the project.
-This folder does not get included in the UI bundle and should _not_ be committed to the source control repository.
-
-[TIP]
-====
-If you prefer to install packages using Yarn, run this command instead:
-
- $ yarn
-====
-
-=== Preview the UI
-
-The default UI project is configured to preview offline.
-The files in the [.path]_preview-src/_ folder provide the sample content that allow you to see the UI in action.
-In this folder, you'll primarily find pages written in AsciiDoc.
-These pages provide a representative sample and kitchen sink of content from the real site.
-
-To build the UI and preview it in a local web server, run the `preview` command:
-
- $ gulp preview
-
-You'll see a URL listed in the output of this command:
-
-....
-[12:00:00] Starting server...
-[12:00:00] Server started http://localhost:5252
-[12:00:00] Running server
-....
-
-Navigate to this URL to preview the site locally.
-
-While this command is running, any changes you make to the source files will be instantly reflected in the browser.
-This works by monitoring the project for changes, running the `preview:build` task if a change is detected, and sending the updates to the browser.
-
-Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
-
-=== Package for Use with Antora
-
-If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
-
- $ gulp bundle
-
-If any errors are reported by lint, you'll need to fix them.
-
-When the command completes successfully, the UI bundle will be available at [.path]_build/ui-bundle.zip_.
-You can point Antora at this bundle using the `--ui-bundle-url` command-line option.
-
-If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
-
- $ gulp bundle:pack
-
-The UI bundle will again be available at [.path]_build/ui-bundle.zip_.
-
-== Copyright and License
-
-Copyright (C) 2017-2019 OpenDevise Inc. and the Antora Project.
-
-Use of this software is granted under the terms of the https://www.mozilla.org/en-US/MPL/2.0/[Mozilla Public License Version 2.0] (MPL-2.0).
-See link:LICENSE[] to find the full license text.
-
-== Authors
-
-Development of Antora is led and sponsored by {url-opendevise}[OpenDevise Inc].
+++ /dev/null
-name: antora-ui-default
-title: Antora Default UI
-version: master
-nav:
-- modules/ROOT/nav.adoc
+++ /dev/null
-* xref:prerequisites.adoc[UI Development Prerequisites]
-* xref:set-up-project.adoc[Set up a UI Project]
-* xref:build-preview-ui.adoc[Build and Preview the UI]
-* xref:development-workflow.adoc[UI Development Workflow]
-* xref:templates.adoc[Work with the Handlebars Templates]
-* xref:stylesheets.adoc[Work with the CSS Stylesheets]
- ** xref:add-fonts.adoc[Add Fonts]
-* xref:style-guide.adoc[UI Element Styles]
-** xref:inline-text-styles.adoc[Inline Text]
-** xref:admonition-styles.adoc[Admonitions]
-** xref:list-styles.adoc[Lists]
-** xref:sidebar-styles.adoc[Sidebars]
-** xref:ui-macro-styles.adoc[UI Macros]
+++ /dev/null
-= Add Fonts
-
-This page explains how to add new fonts to your UI.
-These instructions assume you've forked the default UI and are able to customize it.
-
-There are two steps involved:
-
-. Add the font to your UI project
-. Add a font-face declaration to your stylesheet
-
-You can then reference the font family in your stylesheet.
-
-How you reference the font file in the font-face declaration depends on how you decide to manage it.
-You can manage the font with npm or download it manually and add it directly to your UI project.
-The following sections describe each approach in turn.
-
-== npm managed
-
-You can use npm (or Yarn) to manage the font.
-This approach saves you from having to store the font file directly in your UI project.
-Here are the steps involved.
-
-. Use npm (or Yarn) to install the font files from a package (e.g., https://www.npmjs.com/package/typeface-open-sans[typeface-open-sans])
-
- $ npm install --save typeface-open-sans
-
-. In [.path]_src/css_, add a corresponding CSS file (e.g., [.path]_typeface-open-sans.css_)
-. In that file, declare the font face:
-+
-[source,css]
-----
-@font-face {
- font-family: "Open Sans";
- font-style: normal;
- font-weight: 400;
- src:
- local("Open Sans"),
- local("Open Sans-Regular"),
- url(~typeface-open-sans/files/open-sans-latin-400.woff) format("woff")
-}
-----
-+
-The Gulp build recognizes the `~` URL prefix and copies the font from the npm package to the build folder (and hence bundle).
-
-. Repeat the previous step for each font style and weight you want to use from that package.
-. Change the CSS to use your newly imported font:
-+
-[source,css]
-----
-html {
- font-family: "Open Sans", sans;
-}
-----
-
-. Test the new font by previewing your UI:
-
- $ gulp preview
-
-If you see the new font, you've now successfully added it to your UI.
-If you aren't sure, look for the https://developer.mozilla.org/en-US/docs/Tools/Page_Inspector/How_to/Edit_fonts[All fonts on page] section in your browser's developer tools to see whether the font was loaded.
-
-== Manual
-
-A simpler approach to adding fonts is to store them directly in your project.
-Here are the steps involved.
-
-. Download the font files and add them to the [.path]_src/font_ folder.
-Create this folder if it does not exist.
-. In [.path]_src/css_, add a corresponding CSS file (e.g., [.path]_typeface-open-sans.css_)
-. In that file, declare the font face:
-+
-[source,css]
-----
-@font-face {
- font-family: "Open Sans";
- font-style: normal;
- font-weight: 400;
- src:
- local("Open Sans"),
- local("Open Sans-Regular"),
- url(../font/open-sans-latin-400.woff) format("woff")
-}
-----
-+
-Note that the path is a relative path starting from the [.path]_src/css_ folder to the [.path]_src/font_ folder.
-
-. Repeat the previous step for each font style and weight you want to use.
-. Change the CSS to use your newly imported font:
-+
-[source,css]
-----
-html {
- font-family: "Open Sans", sans;
-}
-----
-
-. Test the new font by previewing your UI:
-
- $ gulp preview
-
-If you see the new font, you've now successfully added it to your UI.
-If you aren't sure, look for the https://developer.mozilla.org/en-US/docs/Tools/Page_Inspector/How_to/Edit_fonts[All fonts on page] section in your browser's developer tools to see whether the font was loaded.
+++ /dev/null
-= Admonition Styles
-
-An xref:antora:asciidoc:admonitions.adoc[admonition], also known as a notice, helps draw attention to content with a special label or icon.
-
-== Admonition blocks
-
-An admonition block is a table.
-The table title element is specified by the block class: tip, note, important, warning, or caution.
-Here's an AsciiDoc source example that produces an admonition with the table title warning:
-
-[source,asciidoc]
-----
-WARNING: Watch out!
-----
-
-If font-based icons are enabled (`icons=font`), the table title text is replaced by the associated icon.
-
-[source,html]
-----
-<div class="admonitionblock warning">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-warning" title="Warning"></i>
-</td>
-<td class="content">
-<div class="paragraph">
-<p>Watch out!</p>
-</div>
-</td>
-</tr>
-</table>
-</div>
-----
-
-Here's how it might appear when the title is displayed as text:
-
-WARNING: Watch out!
+++ /dev/null
-= Build a UI Project for Local Preview
-// Settings:
-:idprefix:
-:idseparator: -
-:experimental:
-
-== Build Preview Site
-
-Once you've modified the site UI, the first thing you'll want to do is check out how it looks.
-That's what the files in the [.path]_preview-src/_ folder are for.
-This folder contains HTML file fragments that provide a representative sample of content from the site.
-The preview saves you from having to generate the whole site just to test the UI.
-These files should give you an idea of how the UI will look when applied to the actual site.
-
-The pages in the preview site are assembled using the Handlebars templates and link to the pre-compiled asset files (emulating the behavior of the site generator).
-Thus, to look at them, you need to run them through the UI build.
-
-There are two preview modes available.
-You can run the build once and examine the result or you can run the build continuously so you can see changes as you make them.
-The next two sections explain how to use these modes.
-
-=== Build Once
-
-To build the UI once for preview, then stop, execute the following command:
-
- $ gulp preview:build
-
-This task pre-compiles the UI files into the [.path]_public_ directory.
-To view the preview pages, navigate to the HTML pages in the [.path]_public_ directory using your browser (e.g., [.path]_public/index.html_).
-
-=== Build Continuously
-
-To avoid the need to run the `preview:build` task over and over while developing, you can use the `preview` command instead to have it run continuously.
-This task also launches a local HTTP server so updates get synchronized with the browser (i.e., "`live reload`").
-
-To launch the preview server, execute the following command:
-
- $ gulp preview
-
-You'll see a URL listed in the output of this command:
-
-....
-[12:59:28] Starting 'preview:serve'...
-[12:59:28] Starting server...
-[12:59:28] Server started http://localhost:5252
-[12:59:28] Running server
-....
-
-Navigate to the URL to view the preview site.
-While this command is running, any changes you make to the source files will be instantly reflected in the browser.
-This works by monitoring the project for changes, running the `preview:build` task if a change is detected, and sending the updates to the browser.
-
-Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
-
-== Package for Previewing
-
-If you need to bundle the UI in order to preview the UI on the real site in local development, run the following command:
-
- $ gulp bundle
-
-The `bundle` command also invokes the `lint` command to check that the CSS and JavaScript follow the coding standards.
-
-The UI bundle will be available at [.path]_build/ui-bundle.zip_.
-You can then point Antora at this bundle using the `--ui-bundle-url` command-line option.
-
-If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
-
- $ gulp bundle:pack
-
-The UI bundle will again be available at [.path]_build/ui-bundle.zip_.
+++ /dev/null
-= UI Development Workflow
-// Settings:
-:idprefix:
-:idseparator: -
-
-// This section provides information about some of the UI files you'll be modifying and how to prepare and submit those changes.
-
-All changes pushed to a UI project's master branch can trigger a new release (not described here).
-Therefore, you want to make your changes to a development branch and submit it as a pull request (PR) to be approved.
-(Even better would be to issue the PR from a fork).
-Only when the PR is approved and merged will the new release be triggered.
-
-== git steps
-
-Use the following command to create a local development branch named `name-me`:
-
- $ git checkout -b name-me -t origin/master
-
-You'll then apply your changes to the UI files.
-Once you're done making changes, commit those changes to the local branch:
-
- $ git commit -a -m "describe your change"
-
-Then, push your branch to the remote repository:
-
- $ git push origin name-me
-
-Finally, navigate to your UI project in your browser and create a new pull request from this branch.
-
-The maintainer of the UI should review the changes.
-If the changes are acceptable, the maintainer will merge the pull request.
-As soon as the pull request is merged into master, an automated process will take over to publish a new release for the site generator to use.
-
-Now that you've got the process down, let's review some of the files you'll be working with in more detail.
+++ /dev/null
-= Antora Default UI
-// Settings:
-:idprefix:
-:idseparator: -
-:experimental:
-:hide-uri-scheme:
-// URIs:
-:uri-antora: https://antora.org
-:uri-repo: https://gitlab.com/antora/antora-ui-default
-:uri-preview: https://antora.gitlab.io/antora-ui-default
-:uri-hbs: http://handlebarsjs.com
-:uri-gulp: http://gulpjs.com
-:uri-npm: https://npmjs.com
-:uri-node: https://nodejs.org
-:uri-nvm: https://github.com/creationix/nvm
-:uri-nvm-install: {uri-nvm}#installation
-:uri-git: https://git-scm.com
-:uri-git-dl: {uri-git}/downloads
-
-This project produces the {uri-preview}[default UI bundle] for documentation sites generated with {uri-antora}[Antora].
-It contains the UI assets (page templates, CSS, JavaScript, images, etc.) and a Gulp build script.
-The build can be used to preview the UI locally (featuring live updates), or to package it for consumption by the Antora site generator.
-
-This documentation explains how to use this project to set up, customize and manage a UI for a documentation site generated with Antora.
-After reading it, you'll be able to:
-
-* [x] Understand how an Antora UI project is structured.
-* [x] Set up your environment to work on the UI project.
-* [x] Launch a preview server to visually inspect the UI.
-* [x] Adopt a development workflow to share and accept changes to the UI.
-* [x] Package a UI for your documentation site that Antora can use.
-
-== File type and technology overview
-
-The Antora UI consists of the following file types that are used to structure and style the documentation site pages generated by Antora.
-
-* Handlebars "`page`" templates (layouts, partials, and helpers)
-* CSS (enhanced using PostCSS)
-* JavaScript (UI scripts)
-* Images / Graphics (specific to the UI)
-* Fonts
-* Sample content for previewing the UI (HTML and UI model)
-
-To understand how the UI works, let's begin by surveying the primary technologies used by the UI.
-
-Handlebars (file extension: `.hbs`)::
-{uri-hbs}[Handlebars] is a "`logic-less`" templating engine used to create HTML from template files.
-Templates contain placeholders (i.e., mustache expressions like `+{{{page.title}}}+`) into which content is injected from a model.
-They also accommodate simple logic expressions for repeating content or including it conditionally (e.g., `+{{#each navigation}}+`) as well as partials (e.g., `+{{> header}}+`).
-
-Gulp (script file: [.path]_gulpfile.js/index.js_)::
-{uri-gulp}[Gulp] is a build tool for JavaScript projects.
-It configures a collection of tasks that can be used to perform automated tasks such as compiling files, running a preview server, or publishing a release.
-
-npm (command: `npm`)::
-npm manages software packages (i.e., software dependencies) that it downloads from {uri-npm}.
-Software this project uses includes libraries that handle compilation as well as shared assets such as font files that are distributed as npm packages.
-npm is part of Node.js.
-
-package.json:::
-This file keeps track of the dependencies (described using fuzzy versions) that npm (or Yarn) should fetch.
-
-package-lock.json:::
-This file contains a report of which dependencies npm resolved.
-This information ensures that dependency resolution is reproducible.
-
-node_modules/:::
-A local cache of resolved dependencies that npm (or Yarn) fetches.
-
-PostCSS::
-This project does not use a CSS preprocessor such as Sass or LESS.
-Instead, it relies on normal CSS which is enhanced by a series of postprocessors.
-The most common postprocessor backports newer CSS features to older browsers by adding properties with vendor prefixes.
-
-== UI project versus UI bundle
-
-The [.term]*UI project*, the master branch of a git repository, contains the recipe and raw materials for creating an Antora UI bundle.
-It includes a build, source files, project files, and dependency information.
-This is your development workspace.
-
-The [.term]*UI bundle*, a distributable archive, provides pre-compiled (interpreted, consolidated, and/or minimized) files that are ready to be used by Antora.
-
-=== UI project repository structure (master branch)
-
-You should think of the UI project's master branch as your UI workspace.
-It contains the recipe and raw materials for creating a UI, including a build, source files, project files, and dependency information.
-
-Here's how the files are structured in the UI project:
-
-[.output]
-....
-README.adoc
-gulpfile.js/
- index.js
- lib/
- tasks/
-package.json
-package-lock.json
-src/
- css/
- base.css
- breadcrumbs.css
- ...
- helpers/
- and.js
- eq.js
- ...
- img/
- back.svg
- caret.svg
- ...
- layouts/
- default.hbs
- 404.hbs
- partials/
- article.hbs
- breadcrumbs.hbs
- ...
- js/
- 01-navigation.js
- 02-fragment-jumper.js
- ...
- vendor/
- highlight.js
-preview-src/
- index.html
- ui-model.yml
-....
-
-A Gulp build is used to compile and assemble the UI project files into a UI bundle.
-
-=== UI bundle structure (releases)
-
-The UI bundle--a distributable archive--provides files which are ready to be used by Antora.
-
-When the UI project files are built by Gulp, they are assembled under the [.path]_public_ directory.
-Since the [.path]_public_ directory is generated, it's safe to remove.
-
-The contents of the UI bundle resembles the UI project's master branch contents, except the bundle doesn't contain any files other than the ones that make up the UI.
-This is the content that is used by Antora.
-
-[.output]
-....
-css/
- site.css
-font/
- ...
-helpers/
- and.js
- eq.js
- ...
-img/
- back.svg
- caret.svg
- ...
-layouts/
- default.hbs
- 404.hbs
-partials/
- article.hbs
- breadcrumbs.hbs
- ...
-js/
- site.js
- vendor/
- highlight.js
-....
-
-Some of these files have been compiled or aggregated, such as the stylesheets and JavaScript.
-The benefit of building the UI files is that the files can be optimized for static inclusion in the site without that optimization getting in the way of UI development.
-For example, the UI build can optimize SVGs or add vendor prefixes to the CSS.
-Since these optimizations are only applied to the pre-compiled files, they don't interfere with the web developer's workflow.
-
-== UI compilation and generator consumption overview
-
-The purpose of an Antora UI project is to get the UI files into a state that Antora can use and to make it reusable.
-
-The UI is served statically in a production site, but the UI's assets live in a source form in a UI project to accommodate development and simplify maintenance.
-When handed off to the Antora pipeline, the UI is in an interim, pre-compiled state.
-Specifically, the master branch of the git repository contains the files in source form while releases are used to distribute the files in pre-compiled form.
-
-The responsibility of compiling the UI is shared between a UI project and Antora.
-The UI project uses a local build to pre-compile (i.e., interpret, consolidate, and/or minimize) the files.
-The pre-compiled files are agnostic to Antora's content model, relieving the generator from having to deal with this part.
-It also allows the UI to be reused.
-
-The UI project build then packages the UI into a bundle, which the UI Loader in Antora consumes.
-Antora grabs the bundle, extracts it into a UI catalog, and takes compilation to completion by weaving the Antora's content model into the Handlebars templates to make the pages and auxiliary data files.
-Antora then copies the remaining UI assets to the site output.
-
-Now that you have an overview of the files that make up the UI and how it gets assembled, let's go over how to set up the project, build the UI, and preview it.
+++ /dev/null
-= Inline Text Styles
-:example-caption!:
-
-////
-When creating a UI theme for Antora, there are certain elements in the UI that require support from the CSS to work correctly.
-This list includes elements in the shell (i.e., frame) and in the document content.
-This document identifies these UI elements.
-////
-
-This page describes how to style text in the contents of the page which is visually emphasized.
-
-[#bold]
-== Bold text (<strong>)
-
-How xref:antora:asciidoc:bold.adoc[text marked as bold] appears on your site depends on the fonts loaded by the UI and the CSS styles the UI applies to the `<strong>` HTML tag.
-
-[source,html]
-----
-A bold <strong>word</strong>, or a bold <strong>phrase of text</strong>.
-----
-
-Since `<strong>` is a semantic HTML element, it automatically inherits default styling (`font-weight: bold`) from the browser.
-If you want to override the browser styles, you'll need to define properties on the `strong` selector in the stylesheet for your UI.
-
-In the default UI, the `<strong>` element is styled in the 500 font weight of the current typeface (Roboto).
-For example:
-
-[example]
-A bold *word*, or a bold *phrase of text*.
-
-[#italic]
-== Italic text (<em>)
-
-How xref:antora:asciidoc:italic.adoc[italicized text] appears on your site depends on the fonts loaded by the UI and the CSS styles the UI applies to the `<em>` HTML tag.
-
-[source,html]
-----
-An italic <em>word</em>, or an italic <em>phrase of text</em>.
-----
-
-Since `<em>` is a semantic HTML element, it automatically inherits default styling (`font-style: italic`) from the browser.
-If you want to override the browser styles, you'll need to define properties on the `em` selector in the stylesheet for your UI.
-
-In the default UI, the `em` element is styled in the italic font variant of the current typeface (Roboto).
-For example:
-
-[example]
-An italic _word_, or an italic _phrase of text_.
-
-[#monospace]
-== Monospace text (<code>)
-
-How xref:antora:asciidoc:monospace.adoc[inline monospace text] is displayed depends on the fixed-width font loaded by your UI and the CSS styles it applies to the `<code>` HTML tag.
-
-[source,html]
-----
-A monospace <code>word</code>, or a monospace <code>phrase of text</code>.
-----
-
-Since `<code>` is a semantic HTML element, it automatically inherits default styling (`font-family: monospace`) from the browser.
-If you want to override the browser styles, you'll need to define properties on the `code` selector in the stylesheet for your UI.
-
-In the default UI, the `code` element is styled using the fixed-width font loaded by the stylesheet (Roboto Mono).
-For example:
-
-[example]
-A monospace `word`, or a monospace `phrase of text`.
-
-[#highlight]
-== Highlighted text (<mark>)
-
-How xref:antora:asciidoc:highlight.adoc[highlighted (or marked) text] appears on your site depends on the CSS styles the UI applies to the `<mark>` HTML tag.
-
-[source,html]
-----
-Let’s add some <mark>highlight</mark> to it.
-----
-
-Since `<mark>` is a semantic HTML element, it automatically inherits default styling (`background-color: yellow`) from the browser.
-Here's an example:
-
-[example]
-Let's add some #highlight# to it.
-
-If you want to override the browser styles, you'll need to define properties on the `mark` selector in the stylesheet for your UI.
+++ /dev/null
-= List Styles
-
-== Ordered list numeration
-
-The browser automatically numbers xref:antora:asciidoc:ordered-and-unordered-lists.adoc[ordered lists] and selects a numeration style by list depth in the following order: decimal, lower-alpha, lower-roman, upper-alpha, upper-roman.
-
-AsciiDoc allows the author to override the numeration style for an ordered list.
-Here's an example of that output:
-
-[source,html]
-----
-<div class="olist loweralpha">
-<ol class="loweralpha" type="a">
-<li><p>a</p></li>
-<li><p>b</p></li>
-<li><p>c</p></li>
-</ol>
-</div>
-----
-
-In order to support this customization, you must assign the list-style-type property to the following classes on the `<ol>` element in your stylesheet.
-
-|===
-|<ol> class |list-style-type property value
-
-|arabic
-|decimal
-
-|decimal
-|decimal-leading-zero
-
-|loweralpha
-|lower-alpha
-
-|lowergreek
-|lower-greek
-
-|lowerroman
-|lower-roman
-
-|upperalpha
-|upper-alpha
-
-|upperroman
-|upper-roman
-|===
-
-== Checklist
-
-A xref:antora:asciidoc:checklists.adoc[checklist] is an unordered list with items that are prefixed with a checkbox marker (checked or unchecked).
-Here's an AsciiDoc source example that produces a checklist:
-
-[source,asciidoc]
-----
-* [ ] todo
-* [x] done!
-----
-
-If font-based icons are enabled (`icons=font`), the checkbox gets inserted as the first element of the paragraph element that contains the list item text.
-
-[source,html]
-----
-<div class="ulist checklist">
-<ul class="checklist">
-<li>
-<p><i class="fa fa-square-o"> todo</p>
-</li>
-<li>
-<p><i class="fa fa-check-square-o"> done!</p>
-</li>
-</ul>
-</div>
-----
-
-The recommended approach is to hide the list markers (`list-style: none`), then add a checkbox glyph on the icon element using either a background image or a `before` pseudo element.
-
-Here's how it might appear:
-
-* [ ] todo
-* [*] done!
+++ /dev/null
-= UI Development Prerequisites
-// Settings:
-:idprefix:
-:idseparator: -
-// URIs:
-:url-nvm: https://github.com/creationix/nvm
-:url-node: https://nodejs.org
-:url-gulp: http://gulpjs.com
-:url-git: https://git-scm.com
-:url-git-dl: {url-git}/downloads
-:url-node-releases: https://nodejs.org/en/about/releases/
-// These prerequisite instructions are less detailed than Antora's prerequisite instructions, I don't know if this is a concern or not.
-
-An Antora UI project is based on tools built atop Node.js, namely:
-
-* {url-node}[Node.js] (commands: `node` and `npm`)
- ** {url-nvm}[nvm] (optional, but strongly recommended)
-* {url-gulp}[Gulp CLI] (command: `gulp`)
-
-You also need {url-git}[git] (command: `git`) to pull down the project and push updates to it.
-
-== git
-
-First, make sure you have git installed.
-
- $ git --version
-
-If not, {url-git-dl}[download and install] the git package for your system.
-
-== Node.js
-
-You need Node.js installed on your machine to use Antora, including the default UI.
-Antora follows the Node.js release schedule, so we advise that you choose an active long term support (LTS) release of Node.js.
-We recommend using the latest active Node.js LTS version.
-While you can use other versions of Node.js, Antora is only tested against LTS releases.
-
-To check whether you have Node.js installed, and which version, open a terminal and type:
-
- $ node --version
-
-You should see a version string, such as:
-
- v10.15.3
-
-If the command fails with an error, it means you don't have Node.js installed.
-The best way to install Node.js is to use nvm (Node Version Manager).
-Refer to xref:antora:install:linux-requirements.adoc#install-nvm[Install nvm and Node.js (Linux)], xref:antora:install:macos-requirements.adoc#install-nvm[Install nvm and Node.js (macOS)], or xref:antora:install:windows-requirements.adoc#install-nvm[Install nvm and Node.js (Windows)] for instructions.
-
-Once you have Node.js installed, you can proceed with installing the Gulp CLI.
-
-== Gulp CLI
-
-Next, you'll need the Gulp CLI (aka wrapper).
-This package provides the `gulp` command which executes the version of Gulp declared by the project.
-You should install the Gulp CLI globally (which resolves to a location in your user directory if you're using nvm) using the following command:
-
- $ npm install -g gulp-cli
-
-Now that you have Node.js and Gulp installed, you're ready to set up the project.
+++ /dev/null
-= Set up a UI Project
-// Settings:
-:idprefix:
-:idseparator: -
-// URIs:
-:uri-project: https://gitlab.com/antora/antora-ui-default.git
-
-Before you can start working on the UI, you need to grab the sources and initialize the project.
-The sources can be {uri-project}[Antora's default UI] or an existing UI project structured to work with Antora.
-
-== Fetch the Default UI project
-
-To start, clone the default UI project using git:
-
-[subs=attributes+]
- $ git clone {uri-project} &&
- cd "`basename $_`"
-
-The example above clones Antora's default UI project and then switches to the project folder on your filesystem.
-Stay in this project folder in order to initialize the project using npm.
-
-== Install dependencies
-
-Next, you'll need to initialize the project.
-Initializing the project essentially means downloading and installing the dependencies into the project.
-That's the job of npm.
-
-In your terminal, execute the following command (while inside the project folder):
-
- $ npm install
-
-This command installs the dependencies listed in [.path]_package.json_ into the [.path]_node_modules/_ folder inside the project.
-This folder does not get included in the UI bundle.
-The folder is safe to delete, though npm does a great job of managing it.
-
-You'll notice another file which seems to be relevant here, [.path]_package-lock.json_.
-npm uses this file to determine which concrete version of a dependency to use, since versions in [.path]_package.json_ are typically just a range.
-The information in this file makes the build reproducible across different machines and runs.
-
-If a new dependency must be resolved that isn't yet listed in [.path]_package-lock.json_, npm will update this file with the new information when you run `npm install`.
-Therefore, you're advised to commit the [.path]_package-lock.json_ file into the repository whenever it changes.
-
-== Supported build tasks
-
-Now that the dependencies are installed, you should be able to run the `gulp` command to find out what tasks the build supports:
-
- $ gulp --tasks-simple
-
-You should see:
-
-[.output]
-....
-default
-clean
-lint
-format
-build
-bundle
-bundle:pack
-preview
-preview:build
-....
-
-We'll explain what each of these tasks are for and when to use them.
+++ /dev/null
-= Sidebar Styles
-
-This page describes the in-page sidebar block styles, not the styles for the navigation sidebar.
-
-== Sidebar blocks
-
-xref:antora:asciidoc:sidebar.adoc[Sidebars] can contain any type of content.
-The sidebar title is specified by the block class title.
-Here's an AsciiDoc source example that produces a sidebar with a title:
-
-[source,asciidoc]
-----
-.Optional Title
-****
-This is a paragraph in a sidebar.
-****
-----
-
-[source,html]
-----
-<div class="sidebarblock">
-<div class="content">
-<div class="title">Optional Title</div>
-<div class="paragraph">
-<p>This is a paragraph in a sidebar.</p>
-</div>
-</div>
-</div>
-----
+++ /dev/null
-= UI Element Style Guide
-
-When creating a UI theme for Antora, there are certain elements in the UI that require support from the CSS to work correctly.
-This list includes elements in the shell (i.e., frame) and in the document content.
-This document identifies these UI elements.
-
-//== UI Shell
-
-// TODO
-
-== Document Content
-
-The HTML in the main content area is generated from AsciiDoc using Asciidoctor.
-AsciiDoc has numerous content elements that require assistance from CSS to render properly.
-
-These elements include:
-
-* xref:inline-text-styles.adoc[Inline text emphasis]
-* xref:admonition-styles.adoc[Admonitions]
-* xref:list-styles.adoc[Lists]
-* xref:sidebar-styles.adoc[Sidebars]
-* xref:ui-macro-styles.adoc[Button, keybinding, and menu UI macros]
+++ /dev/null
-= Work with the CSS Stylesheets
-// Settings:
-:idprefix:
-:idseparator: -
-
-The stylesheets are written in CSS.
-These stylesheets utilize CSS variables to keep the CSS DRY and easy to customize.
-
-== Stylesheet organization and processing
-
-Within the default UI project, the stylesheet files are separated into modules to help organize the rules and make them easier to find.
-The UI build combines and minifies these files into a single file named [.path]_site.css_.
-During the build, the CSS is enhanced using PostCSS in much the same way as a CSS preprocessor works, only the modifications are made to the CSS directly.
-The modifications mostly center around injecting vendor prefixes for compatibility or backporting new features to more broadly supported syntax.
-
-== Add a new CSS rule
-
-Let's consider the case when you want to modify the font size of a section title.
-
-First, make sure you have set up the project and created a development branch.
-Next, open the file [.path]_src/css/doc.css_ and modify the rule for the section title.
-
-[source,css]
-----
-.doc h1 {
- font-size: 2.5rem;
- margin-bottom: 1rem;
- margin-top: 2rem
-}
-----
-
-Save the file, commit it to git, push the branch, and allow the approval workflow to play out.
+++ /dev/null
-= Work with the Handlebars Templates
-// Settings:
-:idprefix:
-:idseparator: -
-
-Antora combines the Handlebars templates with the converted AsciiDoc content to make the pages in the site.
-These "`logic-less`" templates are mostly HTML with some special mustache tags sprinkled in where content is to be inserted.
-
-== What do the templates do?
-
-The layout templates, which are stored in [.path]_src/layouts/_, provide the main page structure.
-The partial templates, in [.path]_src/partials/_, fill in different regions of a page, such as the navigation and footer.
-
-The templates read from a model that's populated by Antora.
-Places in the template where the model is read are enclosed in `{{` and `}}` markers or `{{{` and `}}}`, aka mustaches (e.g., `+{{{page.title}}}+`).
-Double mustaches escape the content, whereas triple mustaches insert the content verbatim.
-When the `{{` is immediately followed by `>`, that's where the result of a partial is inserted (e.g., `+{{> head }}+`.
-
-=== Template variables
-
-CAUTION: This model is not final.
-Variable names and purposes may change.
-
-Here's an overview of the available UI model:
-
-.Variables available to the Handlebars templates
-[#template-variables-table,cols="1m,2"]
-|===
-| Name | Description
-
-| site
-| Information about the site.
-
-| site.url
-| The base URL of the site, if specified in the playbook.
-
-| site.path
-| The pathname (i.e., subpath) of the site.url under which the site is hosted (e.g., /docs).
-Only set if site.url is defined.
-(since Antora 2.1)
-
-| site.title
-| The title of the site.
-
-| site.components
-| A collection of all the components in the site.
-
-| site.ui
-| Information about the site UI.
-
-| site.ui.defaultLayout
-| The default page layout used for this site.
-
-| site.ui.url
-| The absolute base URL of the UI.
-
-| page
-| Information about the current page.
-
-| page.title
-| The page title (also used as the primary heading).
-
-| page.contents
-| The main article content in HTML format.
-Sourced from AsciiDoc and converted to HTML by the Asciidoctor processor.
-
-| page.attributes
-| Any AsciiDoc document attribute prefixed with `page-`.
-The `page-` prefix is dropped from the name used in this model.
-For example, the value of the document attribute named `page-support-phone` can be accessed via the UI model using `page.attributes.support-phone`.
-Page attributes can be defined per page in the AsciiDoc document header (e.g., `:page-support-phone: +1 212-555-1234`) or globally in the playbook under the key `asciidoc.attributes`.
-The `page-` prefix is used to isolate page-related attributes from the numerous other document attributes in AsciiDoc.
-
-| page.description
-| The text of the description attribute in the AsciiDoc header, if specified.
-
-| page.keywords
-| A comma-separated list of keywords defined in the AsciiDoc header, if specified.
-
-| page.component
-| Information about the component for the current page.
-Properties include name, title, and versions.
-
-| page.componentVersion
-| Information about the component version for the current page.
-Properties include name, title, and url.
-
-| page.module
-| The name of the module for the current page.
-
-| page.version
-| The name of the version for the current page.
-
-| page.versions
-| All versions of the current page, including the current page.
-Each entry has the properties url, string, and missing.
-
-| page.breadcrumbs
-| An array of breadcrumb items that represent the current selection in the navigation tree.
-
-| page.navigation
-| A collection of navigation links for the current page.
-Each navigation item contains the property `content` as well as the optional properties `url` and (child) `items`.
-
-| page.url
-| The URL for the current page.
-This value is a root-relative path.
-It's often used as the base URL to generate relative URLs from this page.
-
-| page.canonicalUrl
-| The canonical URL for the current page.
-The canonicalUrl is only set if site.url is set.
-If there are multiple versions of the component, the canonical URL is the qualified URL of the most recent version of the page (excluding any prerelease versions).
-If there's only a single version of the component, the canonical URL is the qualified URL of the current page.
-
-| page.editUrl
-| The URL to edit the current page (typically a web-based editor on the git host).
-The only hosts supported right now are github.com, gitlab.com, pagure.io, and bitbucket.org.
-
-| page.origin.private
-| This value will be true if the repository requires authentication or the repository URL embeds credentials.
-In the default UI, if this value is `true`, the "Edit this Page" link is disabled.
-A quick way to force this property to be `true` (even if the repository is public) is to begin the content source URL in the playbook with empty credentials, as in `\https://@`.
-Then, the "Edit the Page" link will not appear.
-
-| page.home
-| Indicates whether the current page is the home page of the site.
-
-| page.layout
-| The page layout for the current page.
-
-| page.next
-| The next logical page in the navigation tree.
-
-| page.previous
-| The previous logical page in the navigation tree.
-
-| page.parent
-| The parent page in the navigation tree. Will resolve to grandparent if parent item is not a page.
-
-| siteRootPath
-| The relative path to the root of the published site.
-
-| uiRootPath
-| The relative path to the root directory of the UI.
-
-| env
-| The map of environment variables (sourced from `process.env`).
-
-| antoraVersion
-| The version of Antora used to build the site (specifically the version of the @antora/page-composer package).
-|===
-
-This model is likely to grow over time.
-
-== Modify a template
-
-Let's consider the case when you want to add a new meta tag inside the HTML head.
-
-First, make sure you have set up the project and created a development branch.
-Next, open the file [.path]_templates/partials/head.hbs_ and add your tag.
-
-[source,html]
-----
-<meta class="swiftype" name="title" data-type="string" content="{{page.title}}">
-----
-
-Each template file has access to the template model, which exposes information about the current page through variable names.
-The variables currently available are listed in <<template-variables-table>>.
-
-Save the file, commit it to git, push the branch, and allow the approval workflow to play out.
+++ /dev/null
-= UI Macro Styles
-
-Asciidoctor supports xref:antora:asciidoc:ui-macros.adoc[three UI element representations] out of the box, which are made from corresponding inline UI macros.
-
-* button (btn macro)
-* keybinding (kbd macro)
-* menu (menu macro)
-
-The UI elements are output using semantic HTML elements, so they inherit some default styling from the browser.
-However, to look proper, they require some additional styling.
-
-== Button
-
-A xref:antora:asciidoc:ui-macros.adoc#button[button] is meant to represent an on-screen button (`+btn:[Save]+`).
-However, it should not appear like an actual button as that could confuse the reader into thinking it's interactive.
-Therefore, a button is rendered as a bold text by default:
-
-[source,html]
-----
-<b class="button">Save</b>
-----
-
-Traditionally, a button reference is styled by surrounding the text with square brackets, as shown here:
-
-btn:[Save]
-
-== Keybinding
-
-A xref:antora:asciidoc:ui-macros.adoc#keybinding[keybinding] can be a single key (`+kbd:[F11]+`) or a sequence of keys (`+kbd:[Ctrl+F]`).
-Here's the HTML that's generated for these two forms.
-
-[source,html]
-----
-<kbd>F11</kbd>
-<span class="keyseq"><kbd>Ctrl</kbd>+<kbd>F</kbd></span>
-----
-
-Here's how these might appear:
-
-[%hardbreaks]
-kbd:[F11]
-kbd:[Ctrl+F]
-
-== Menu
-
-A xref:antora:asciidoc:ui-macros.adoc#menu[menu] can be a top-level menu reference (`+menu:File[]+`) or a nested selection (`+menu:File[Save]+`).
-Here's the HTML that's generated for these two forms.
-
-[source,html]
-----
-<b class="menuref">File</b>
-<span class="menuseq"><b class="menu">File</b> <b class="caret">›</b> <b class="menuitem">Save</b></span>
-----
-
-This might be rendered as:
-
-menu:File[]
-
-menu:File[Save]
-
-The default styling applied to a menu reference is usually sufficient.
+++ /dev/null
-'use strict'
-
-const metadata = require('undertaker/lib/helpers/metadata')
-const { watch } = require('gulp')
-
-module.exports = ({ name, desc, opts, call: fn, loop }) => {
- if (name) {
- const displayName = fn.displayName
- if (displayName === '<series>' || displayName === '<parallel>') {
- metadata.get(fn).tree.label = `${displayName} ${name}`
- }
- fn.displayName = name
- }
- if (loop) {
- const delegate = fn
- name = delegate.displayName
- delegate.displayName = `${name}:loop`
- fn = () => watch(loop, { ignoreInitial: false }, delegate)
- fn.displayName = name
- }
- if (desc) fn.description = desc
- if (opts) fn.flags = opts
- return fn
-}
+++ /dev/null
-'use strict'
-
-module.exports = (...tasks) => {
- const seed = {}
- if (tasks.length) {
- if (tasks.lastIndexOf(tasks[0]) > 0) {
- const task1 = tasks.shift()
- seed.default = Object.assign(task1.bind(null), { description: `=> ${task1.displayName}`, displayName: 'default' })
- }
- return tasks.reduce((acc, it) => (acc[it.displayName || it.name] = it) && acc, seed)
- } else {
- return seed
- }
-}
+++ /dev/null
-'use strict'
-
-const { obj: map } = require('through2')
-const PluginError = require('plugin-error')
-const prettierEslint = require('prettier-eslint')
-
-module.exports = () => {
- const report = { changed: 0, unchanged: 0 }
- return map(format).on('finish', () => {
- if (report.changed > 0) {
- const changed = 'formatted '
- .concat(report.changed)
- .concat(' file')
- .concat(report.changed === 1 ? '' : 's')
- const unchanged = 'left '
- .concat(report.unchanged)
- .concat(' file')
- .concat(report.unchanged === 1 ? '' : 's')
- .concat(' unchanged')
- console.log(`prettier-eslint: ${changed}; ${unchanged}`)
- } else {
- console.log(`prettier-eslint: left ${report.unchanged} file${report.unchanged === 1 ? '' : 's'} unchanged`)
- }
- })
-
- function format (file, enc, next) {
- if (file.isNull()) return next()
- if (file.isStream()) return next(new PluginError('gulp-prettier-eslint', 'Streaming not supported'))
-
- const input = file.contents.toString()
- const output = prettierEslint({ text: input, filePath: file.path })
-
- if (input === output) {
- report.unchanged += 1
- } else {
- report.changed += 1
- file.contents = Buffer.from(output)
- }
-
- next(null, file)
- }
-}
+++ /dev/null
-'use strict'
-
-const asciidoctor = require('asciidoctor.js')()
-const fs = require('fs-extra')
-const handlebars = require('handlebars')
-const { obj: map } = require('through2')
-const merge = require('merge-stream')
-const ospath = require('path')
-const path = ospath.posix
-const requireFromString = require('require-from-string')
-const vfs = require('vinyl-fs')
-const yaml = require('js-yaml')
-
-const ASCIIDOC_ATTRIBUTES = {
- experimental: '',
- icons: 'font',
- sectanchors: '',
- 'source-highlighter': 'highlight.js',
-}
-
-module.exports = (src, previewSrc, previewDest, sink = () => map(), layouts = {}) => () =>
- Promise.all([
- loadSampleUiModel(previewSrc),
- toPromise(
- merge(
- compileLayouts(src, layouts),
- registerPartials(src),
- registerHelpers(src),
- copyImages(previewSrc, previewDest)
- )
- ),
- ])
- .then(([baseUiModel]) => ({ ...baseUiModel, env: process.env }))
- .then((baseUiModel) =>
- vfs
- .src('**/*.adoc', { base: previewSrc, cwd: previewSrc })
- .pipe(
- map((file, enc, next) => {
- const siteRootPath = path.relative(ospath.dirname(file.path), ospath.resolve(previewSrc))
- const uiModel = { ...baseUiModel }
- uiModel.page = { ...uiModel.page }
- uiModel.siteRootPath = siteRootPath
- uiModel.siteRootUrl = path.join(siteRootPath, 'index.html')
- uiModel.uiRootPath = path.join(siteRootPath, '_')
- if (file.stem === '404') {
- uiModel.page = { layout: '404', title: 'Page Not Found' }
- } else {
- const doc = asciidoctor.load(file.contents, { safe: 'safe', attributes: ASCIIDOC_ATTRIBUTES })
- uiModel.page.attributes = Object.entries(doc.getAttributes())
- .filter(([name, val]) => name.startsWith('page-'))
- .reduce((accum, [name, val]) => {
- accum[name.substr(5)] = val
- return accum
- }, {})
- uiModel.page.layout = doc.getAttribute('page-layout', 'default')
- uiModel.page.title = doc.getDocumentTitle()
- uiModel.page.contents = Buffer.from(doc.convert())
- }
- file.extname = '.html'
- file.contents = Buffer.from(layouts[uiModel.page.layout](uiModel))
- next(null, file)
- })
- )
- .pipe(vfs.dest(previewDest))
- .pipe(sink())
- )
-
-function loadSampleUiModel (src) {
- return fs.readFile(ospath.join(src, 'ui-model.yml'), 'utf8').then((contents) => yaml.safeLoad(contents))
-}
-
-function registerPartials (src) {
- return vfs.src('partials/*.hbs', { base: src, cwd: src }).pipe(
- map((file, enc, next) => {
- handlebars.registerPartial(file.stem, file.contents.toString())
- next()
- })
- )
-}
-
-function registerHelpers (src) {
- return vfs.src('helpers/*.js', { base: src, cwd: src }).pipe(
- map((file, enc, next) => {
- handlebars.registerHelper(file.stem, requireFromString(file.contents.toString()))
- next()
- })
- )
-}
-
-function compileLayouts (src, layouts) {
- return vfs.src('layouts/*.hbs', { base: src, cwd: src }).pipe(
- map((file, enc, next) => {
- layouts[file.stem] = handlebars.compile(file.contents.toString(), { preventIndent: true })
- next()
- })
- )
-}
-
-function copyImages (src, dest) {
- return vfs.src('**/*.{png,svg}', { base: src, cwd: src }).pipe(vfs.dest(dest))
-}
-
-function toPromise (stream) {
- return new Promise((resolve, reject) => stream.on('error', reject).on('finish', resolve))
-}
+++ /dev/null
-'use strict'
-
-const autoprefixer = require('autoprefixer')
-const browserify = require('browserify')
-const buffer = require('vinyl-buffer')
-const concat = require('gulp-concat')
-const cssnano = require('cssnano')
-const fs = require('fs-extra')
-const imagemin = require('gulp-imagemin')
-const { obj: map } = require('through2')
-const merge = require('merge-stream')
-const ospath = require('path')
-const path = ospath.posix
-const postcss = require('gulp-postcss')
-const postcssCalc = require('postcss-calc')
-const postcssImport = require('postcss-import')
-const postcssUrl = require('postcss-url')
-const postcssVar = require('postcss-custom-properties')
-const uglify = require('gulp-uglify')
-const vfs = require('vinyl-fs')
-
-module.exports = (src, dest, preview) => () => {
- const opts = { base: src, cwd: src }
- const sourcemaps = preview || process.env.SOURCEMAPS === 'true'
- const postcssPlugins = [
- postcssImport,
- postcssUrl([
- {
- filter: '**/~typeface-*/files/*',
- url: (asset) => {
- const relpath = asset.pathname.substr(1)
- const abspath = require.resolve(relpath)
- const basename = ospath.basename(abspath)
- const destpath = ospath.join(dest, 'font', basename)
- if (!fs.pathExistsSync(destpath)) fs.copySync(abspath, destpath)
- return path.join('..', 'font', basename)
- },
- },
- ]),
- postcssVar({ preserve: preview ? 'preserve-computed' : false }),
- preview ? postcssCalc : () => {},
- autoprefixer,
- preview ? () => {} : cssnano({ preset: 'default' }),
- ]
-
- return merge(
- vfs
- .src('js/+([0-9])-*.js', { ...opts, sourcemaps })
- .pipe(uglify())
- .pipe(concat('js/site.js')),
- vfs
- .src('js/vendor/*.js', { ...opts, read: false })
- .pipe(
- // see https://gulpjs.org/recipes/browserify-multiple-destination.html
- map((file, enc, next) => {
- if (file.relative.endsWith('.bundle.js')) {
- file.contents = browserify(file.relative, { basedir: src, detectGlobals: false })
- .plugin('browser-pack-flat/plugin')
- .bundle()
- file.path = file.path.slice(0, file.path.length - 10) + '.js'
- next(null, file)
- } else {
- fs.readFile(file.path, 'UTF-8').then((contents) => {
- file.contents = Buffer.from(contents)
- next(null, file)
- })
- }
- })
- )
- .pipe(buffer())
- .pipe(uglify()),
- vfs.src('css/site.css', { ...opts, sourcemaps }).pipe(postcss(postcssPlugins)),
- vfs.src('font/*.{ttf,woff*(2)}', opts),
- vfs
- .src('img/**/*.{gif,ico,jpg,png,svg}', opts)
- .pipe(
- imagemin([
- imagemin.gifsicle(),
- imagemin.jpegtran(),
- imagemin.optipng(),
- imagemin.svgo({ plugins: [{ removeViewBox: false }] }),
- ].reduce((accum, it) => it ? accum.concat(it) : accum, []))
- ),
- vfs.src('helpers/*.js', opts),
- vfs.src('layouts/*.hbs', opts),
- vfs.src('partials/*.hbs', opts)
- ).pipe(vfs.dest(dest, { sourcemaps: sourcemaps && '.' }))
-}
+++ /dev/null
-'use strict'
-
-const prettier = require('../lib/gulp-prettier-eslint')
-const vfs = require('vinyl-fs')
-
-module.exports = (files) => () =>
- vfs
- .src(files)
- .pipe(prettier())
- .pipe(vfs.dest((file) => file.base))
+++ /dev/null
-'use strict'
-
-const camelCase = (name) => name.replace(/[-]./g, (m) => m.substr(1).toUpperCase())
-
-module.exports = require('require-directory')(module, __dirname, { recurse: false, rename: camelCase })
+++ /dev/null
-'use strict'
-
-const stylelint = require('gulp-stylelint')
-const vfs = require('vinyl-fs')
-
-module.exports = (files) => (done) =>
- vfs
- .src(files)
- .pipe(stylelint({ reporters: [{ formatter: 'string', console: true }], failAfterError: true }))
- .on('error', done)
+++ /dev/null
-'use strict'
-
-const eslint = require('gulp-eslint')
-const vfs = require('vinyl-fs')
-
-module.exports = (files) => (done) =>
- vfs
- .src(files)
- .pipe(eslint())
- .pipe(eslint.format())
- .pipe(eslint.failAfterError())
- .on('error', done)
+++ /dev/null
-'use strict'
-
-const vfs = require('vinyl-fs')
-const zip = require('gulp-vinyl-zip')
-
-module.exports = (src, dest, bundleName) => () =>
- vfs
- .src('**/*', { base: src, cwd: src })
- .pipe(zip.zip(`${bundleName}-bundle.zip`))
- .pipe(vfs.dest(dest))
+++ /dev/null
-'use strict'
-
-const fs = require('fs-extra')
-const { obj: map } = require('through2')
-const vfs = require('vinyl-fs')
-
-module.exports = (files) => () =>
- vfs.src(files, { allowEmpty: true }).pipe(map((file, enc, next) => fs.remove(file.path, next)))
+++ /dev/null
-'use strict'
-
-const connect = require('gulp-connect')
-const os = require('os')
-
-const ANY_HOST = '0.0.0.0'
-const URL_RX = /(https?):\/\/(?:[^/: ]+)(:\d+)?/
-
-module.exports = (root, opts = {}, watch = undefined) => (done) => {
- connect.server({ ...opts, middleware: opts.host === ANY_HOST ? decorateLog : undefined, root }, function () {
- this.server.on('close', done)
- if (watch) watch()
- })
-}
-
-function decorateLog (_, app) {
- const _log = app.log
- app.log = (msg) => {
- if (msg.startsWith('Server started ')) {
- const localIp = getLocalIp()
- const replacement = '$1://localhost$2' + (localIp ? ` and $1://${localIp}$2` : '')
- msg = msg.replace(URL_RX, replacement)
- }
- _log(msg)
- }
- return []
-}
-
-function getLocalIp () {
- for (const records of Object.values(os.networkInterfaces())) {
- for (const record of records) {
- if (!record.internal && record.family === 'IPv4') return record.address
- }
- }
- return 'localhost'
-}
+++ /dev/null
-'use strict'
-
-const { parallel, series, watch } = require('gulp')
-const createTask = require('./gulp.d/lib/create-task')
-const exportTasks = require('./gulp.d/lib/export-tasks')
-
-const bundleName = 'ui'
-const buildDir = 'build'
-const previewSrcDir = 'preview-src'
-const previewDestDir = 'public'
-const srcDir = 'src'
-const destDir = `${previewDestDir}/_`
-const { reload: livereload } = process.env.LIVERELOAD === 'true' ? require('gulp-connect') : {}
-const serverConfig = { host: '0.0.0.0', port: 5252, livereload }
-
-const task = require('./gulp.d/tasks')
-const glob = {
- all: [srcDir, previewSrcDir],
- css: `${srcDir}/css/**/*.css`,
- js: ['gulpfile.js', 'gulp.d/**/*.js', `${srcDir}/{helpers,js}/**/*.js`],
-}
-
-const cleanTask = createTask({
- name: 'clean',
- desc: 'Clean files and folders generated by build',
- call: task.remove(['build', 'public']),
-})
-
-const lintCssTask = createTask({
- name: 'lint:css',
- desc: 'Lint the CSS source files using stylelint (standard config)',
- call: task.lintCss(glob.css),
-})
-
-const lintJsTask = createTask({
- name: 'lint:js',
- desc: 'Lint the JavaScript source files using eslint (JavaScript Standard Style)',
- call: task.lintJs(glob.js),
-})
-
-const lintTask = createTask({
- name: 'lint',
- desc: 'Lint the CSS and JavaScript source files',
- call: parallel(lintCssTask, lintJsTask),
-})
-
-const formatTask = createTask({
- name: 'format',
- desc: 'Format the JavaScript source files using prettify (JavaScript Standard Style)',
- call: task.format(glob.js),
-})
-
-const buildTask = createTask({
- name: 'build',
- desc: 'Build and stage the UI assets for bundling',
- call: task.build(srcDir, destDir, process.argv.slice(2).some((name) => name.startsWith('preview'))),
-})
-
-const bundleBuildTask = createTask({
- name: 'bundle:build',
- call: series(cleanTask, lintTask, buildTask),
-})
-
-const bundlePackTask = createTask({
- name: 'bundle:pack',
- desc: 'Create a bundle of the staged UI assets for publishing',
- call: task.pack(destDir, buildDir, bundleName),
-})
-
-const bundleTask = createTask({
- name: 'bundle',
- desc: 'Clean, lint, build, and bundle the UI for publishing',
- call: series(bundleBuildTask, bundlePackTask),
-})
-
-const packTask = createTask({
- name: 'pack',
- desc: '(deprecated; use bundle instead)',
- call: series(bundleTask),
-})
-
-const buildPreviewPagesTask = createTask({
- name: 'preview:build-pages',
- call: task.buildPreviewPages(srcDir, previewSrcDir, previewDestDir, livereload),
-})
-
-const previewBuildTask = createTask({
- name: 'preview:build',
- desc: 'Process and stage the UI assets and generate pages for the preview',
- call: parallel(buildTask, buildPreviewPagesTask),
-})
-
-const previewServeTask = createTask({
- name: 'preview:serve',
- call: task.serve(previewDestDir, serverConfig, () => watch(glob.all, previewBuildTask)),
-})
-
-const previewTask = createTask({
- name: 'preview',
- desc: 'Generate a preview site and launch a server to view it',
- call: series(previewBuildTask, previewServeTask),
-})
-
-module.exports = exportTasks(
- bundleTask,
- cleanTask,
- lintTask,
- formatTask,
- buildTask,
- bundleTask,
- bundlePackTask,
- previewTask,
- previewBuildTask,
- packTask
-)
+++ /dev/null
-{
- "name": "antora-ui-default",
- "description": "An archetype project that produces a UI for creating documentation sites with Antora",
- "homepage": "https://gitlab.com/antora/antora-ui-default",
- "license": "MPL-2.0",
- "repository": {
- "type": "git",
- "url": "https://gitlab.com/antora/antora-ui-default.git"
- },
- "engines": {
- "node": ">= 8.0.0"
- },
- "browserslist": [
- "last 2 versions"
- ],
- "devDependencies": {
- "asciidoctor.js": "1.5.9",
- "autoprefixer": "~9.6",
- "browser-pack-flat": "~3.4",
- "browserify": "~16.5",
- "cssnano": "~4.1",
- "eslint": "~6.3",
- "eslint-config-standard": "~14.1",
- "eslint-plugin-import": "~2.18",
- "eslint-plugin-node": "~9.2",
- "eslint-plugin-promise": "~4.2",
- "eslint-plugin-standard": "~4.0",
- "fs-extra": "~8.1",
- "gulp": "~4.0",
- "gulp-concat": "~2.6",
- "gulp-connect": "~5.7",
- "gulp-eslint": "~6.0",
- "gulp-imagemin": "~6.1",
- "gulp-postcss": "~8.0",
- "gulp-stylelint": "~9.0",
- "gulp-uglify": "~3.0",
- "gulp-vinyl-zip": "~2.1 >=2.1.2",
- "handlebars": "~4.4",
- "highlight.js": "~9.15",
- "js-yaml": "~3.13",
- "merge-stream": "~2.0",
- "postcss-calc": "~7.0",
- "postcss-custom-properties": "~9.0",
- "postcss-import": "~12.0",
- "postcss-url": "~8.0",
- "prettier-eslint": "~9.0",
- "require-directory": "~2.1",
- "require-from-string": "~2.0",
- "stylelint": "~10.1",
- "stylelint-config-standard": "~18.3",
- "through2": "~3.0",
- "typeface-roboto": "0.0.75",
- "typeface-roboto-mono": "0.0.75",
- "vinyl-buffer": "~1.0",
- "vinyl-fs": "~3.0"
- }
-}
+++ /dev/null
-= Hardware and Software Requirements
-Author Name
-:idprefix:
-:idseparator: -
-:!example-caption:
-:!table-caption:
-
-image:multirepo-ssg.svg[Multirepo SSG,200,float=right]
-Platonem complectitur mediocritatem ea eos.
-Ei nonumy deseruisse ius.
-Mel id omnes verear.
-Vis no velit audiam, sonet <<dependencies,praesent>> eum ne.
-*Prompta eripuit* nec ad.
-Integer diam enim, dignissim eget eros et, ultricies mattis odio.
-Vestibulum consectetur nec urna a luctus.
-Quisque pharetra tristique arcu fringilla dapibus.
-Curabitur ut massa aliquam, cursus enim et, accumsan lectus.
-
-== Cu solet
-
-Nominavi luptatum eos, an vim hinc philosophia intellegebat.
-Lorem `expetenda` pertinacia et nec, [.underline]#wisi# illud [.line-through]#sonet# qui ea.
-Eum an doctus <<liber-recusabo,maiestatis efficiantur>>.
-Eu mea inani iriure.
-
-[source,json]
-----
-{
- "name": "module-name",
- "version": "10.0.1",
- "description": "An example module to illustrate the usage of package.json",
- "author": "Author Name <author@example.com>",
- "scripts": {
- "test": "mocha",
- "lint": "eslint"
- }
-}
-----
-
-.Example paragraph syntax
-[source,asciidoc]
-----
-.Optional title
-[example]
-This is an example paragraph.
-----
-
-.Optional title
-[example]
-This is an example paragraph.
-
-How about some code?
-
-[source,js]
-----
-vfs
- .src('js/vendor/*.js', { cwd: 'src', cwdbase: true, read: false })
- .pipe(tap((file) => { // <1>
- file.contents = browserify(file.relative, { basedir: 'src', detectGlobals: false }).bundle()
- }))
- .pipe(buffer()) // <2>
- .pipe(uglify())
- .pipe(gulp.dest('build'))
-----
-<1> The tap function is used to wiretap the data in the pipe.
-<2> Wrap streaming files in buffers so they can be processed by uglify.
-
-Cum dicat #putant# ne.
-Est in <<inline,reque>> homero principes, meis deleniti mediocrem ad has.
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
-
-....
-pom.xml
-src/
- main/
- java/
- HelloWorld.java
- test/
- java/
- HelloWorldTest.java
-....
-
-Select menu:File[Open Project] to open the project in your IDE.
-Per ea btn:[Cancel] inimicus.
-Ferri kbd:[F11] tacimates constituam sed ex, eu mea munere vituperata kbd:[Ctrl,T] constituam.
-
-.Sidebar Title
-****
-Platonem complectitur mediocritatem ea eos.
-Ei nonumy deseruisse ius.
-Mel id omnes verear.
-
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
-****
-
-=== Liber recusabo
-
-No sea, at invenire voluptaria mnesarchum has.
-Ex nam suas nemore dignissim, vel apeirian democritum et.
-At ornatus splendide sed, phaedrum omittantur usu an, vix an noster voluptatibus.
-
-. potenti donec cubilia tincidunt
-. etiam pulvinar inceptos velit quisque aptent himenaeos
-. lacus volutpat semper porttitor aliquet ornare primis nulla enim
-
-Natum facilisis theophrastus an duo.
-No sea, at invenire voluptaria mnesarchum has.
-
-* ultricies sociosqu tristique integer
-* lacus volutpat semper porttitor aliquet ornare primis nulla enim
-* etiam pulvinar inceptos velit quisque aptent himenaeos
-
-Eu sed antiopam gloriatur.
-Ea mea agam graeci philosophia.
-
-* [ ] todo
-* [x] done!
-
-Vis veri graeci legimus ad.
-
-sed::
-splendide sed
-
-mea::
-agam graeci
-
-At ornatus splendide sed.
-
-.Library dependencies
-[#dependencies%autowidth]
-|===
-|Library |Version
-
-|eslint
-|^1.7.3
-
-|eslint-config-gulp
-|^2.0.0
-
-|expect
-|^1.20.2
-
-|istanbul
-|^0.4.3
-
-|istanbul-coveralls
-|^1.0.3
-
-|jscs
-|^2.3.5
-|===
-
-Cum dicat putant ne.
-Est in reque homero principes, meis deleniti mediocrem ad has.
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
-
-[TIP]
-This oughta do it!
-
-Cum dicat putant ne.
-Est in reque homero principes, meis deleniti mediocrem ad has.
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
-
-[NOTE]
-====
-You've been down _this_ road before.
-====
-
-Cum dicat putant ne.
-Est in reque homero principes, meis deleniti mediocrem ad has.
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
-
-[WARNING]
-====
-Watch out!
-====
-
-[CAUTION]
-====
-[#inline]#I wouldn't try that if I were you.#
-====
-
-[IMPORTANT]
-====
-Don't forget this step!
-====
-
-.Key Points to Remember
-[TIP]
-====
-If you installed the CLI and the default site generator globally, you can upgrade both of them with the same command.
-
- $ npm i -g @antora/cli @antora/site-generator-default
-====
-
-Nominavi luptatum eos, an vim hinc philosophia intellegebat.
-Eu mea inani iriure.
-
-[discrete]
-== Voluptua singulis
-
-Cum dicat putant ne.
-Est in reque homero principes, meis deleniti mediocrem ad has.
-Ex nam suas nemore dignissim, vel apeirian democritum et.
-
-.Antora is a multi-repo documentation site generator
-image::multirepo-ssg.svg[Multirepo SSG,250]
-
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
-
-[quote, 'Famous Person. Cum dicat putant ne.', 'Cum dicat putant ne. https://example.com[Famous Person Website]']
-____
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris eget leo nunc, nec tempus mi? Curabitur id nisl mi, ut vulputate urna. Quisque porta facilisis tortor, vitae bibendum velit fringilla vitae! Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris eget leo nunc, nec tempus mi? Curabitur id nisl mi, ut vulputate urna. Quisque porta facilisis tortor, vitae bibendum velit fringilla vitae!
-____
-
-That's all, folks!
+++ /dev/null
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 30">
-<defs>
-<filter id="b" width="1.041" height="1.058" x="-.021" y="-.029" color-interpolation-filters="sRGB">
-<feGaussianBlur stdDeviation=".172"/>
-</filter>
-<filter id="a" width="1.021" height="1.029" x="-.01" y="-.014" color-interpolation-filters="sRGB">
-<feGaussianBlur stdDeviation=".086"/>
-</filter>
-</defs>
-<rect width="20.063" height="14.331" x="9.968" y="14.969" fill="#3d3d3d" filter="url(#a)" rx="1.66" ry="1.66"/>
-<path fill="#ff6f00" stroke-width="1.113" d="M27.364 4.53a3.8 3.8 0 0 0-1.201 7.406c.19.035.26-.082.26-.183l-.006-.707c-1.057.23-1.28-.449-1.28-.449-.173-.439-.422-.556-.422-.556-.345-.236.026-.23.026-.23.382.026.583.39.583.39.338.582.889.414 1.105.317.035-.246.133-.413.242-.508-.844-.096-1.732-.422-1.732-1.878 0-.415.149-.754.392-1.02-.04-.096-.17-.483.037-1.006 0 0 .319-.102 1.045.39.303-.085.628-.127.951-.128.323.001.648.043.952.128.725-.492 1.044-.39 1.044-.39.207.523.077.91.037 1.006.244.266.391.605.391 1.02 0 1.46-.889 1.78-1.735 1.875.137.118.258.349.258.703 0 .509-.004.918-.004 1.043 0 .101.068.22.26.183a3.8 3.8 0 0 0-1.203-7.406zm-2.377 5.413c-.008.02-.038.025-.065.012-.027-.013-.043-.038-.034-.057.008-.02.038-.025.065-.012.028.012.044.038.034.057zm.187.167c-.018.017-.053.01-.077-.017-.025-.027-.03-.062-.012-.08.02-.016.053-.008.078.018.025.027.03.062.011.08zm.128.213c-.023.017-.061.002-.085-.032-.023-.034-.023-.075.001-.09.024-.017.061-.002.085.031.023.034.023.075 0 .091zm.217.248c-.02.023-.065.016-.097-.015-.034-.03-.043-.074-.022-.097.021-.023.066-.017.098.015.033.03.043.074.021.097zm.28.083c-.009.03-.051.043-.094.03-.043-.012-.072-.047-.063-.077.01-.03.052-.044.095-.03.043.012.071.047.063.077zm.32.035c0 .032-.036.058-.081.058-.046.001-.082-.024-.083-.055 0-.031.036-.057.081-.058.046 0 .083.024.083.055zm.313-.012c.005.031-.026.062-.071.07-.044.009-.085-.01-.09-.04-.006-.032.026-.063.07-.071.045-.008.085.01.09.041z"/>
-<path fill="#ff6f00" stroke-width=".902" d="M23.85 3.643L20.355.151a.515.515 0 0 0-.728 0l-.726.725.92.92a.612.612 0 0 1 .775.78l.887.887a.612.612 0 1 1-.367.345l-.827-.827v2.177a.613.613 0 1 1-.504-.018V2.943a.613.613 0 0 1-.333-.804l-.907-.907-2.395 2.395a.515.515 0 0 0 0 .729l3.493 3.493a.515.515 0 0 0 .728 0l3.477-3.477a.516.516 0 0 0 0-.729"/>
-<g fill-rule="evenodd">
-<path fill="#fc6d26" d="M16.363 7.948l-.425-1.309-.843-2.594a.145.145 0 0 0-.275 0l-.843 2.594h-2.799l-.843-2.594a.145.145 0 0 0-.275 0l-.843 2.594-.425 1.309a.29.29 0 0 0 .105.324l3.68 2.674 3.68-2.674a.29.29 0 0 0 .106-.324"/>
-<path fill="#c43e00" d="M12.577 10.942l1.4-4.307h-2.8z"/>
-<path fill="#ff6f00" d="M12.577 10.942l-1.399-4.307H9.217z"/>
-<path fill="#ffa040" d="M9.217 6.631L8.792 7.94a.29.29 0 0 0 .105.324l3.68 2.674z"/>
-<path fill="#c43e00" d="M9.217 6.632h1.961l-.843-2.594a.145.145 0 0 0-.275 0z"/>
-<path fill="#ff6f00" d="M12.578 10.942l1.4-4.307h1.96z"/>
-<path fill="#ffa040" d="M15.938 6.631l.426 1.309a.29.29 0 0 1-.106.324l-3.68 2.674z"/>
-<path fill="#c43e00" d="M15.938 6.632h-1.961l.843-2.594a.145.145 0 0 1 .275 0z"/>
-</g>
-<g fill="none" stroke="#ff6f00" stroke-linecap="round" stroke-linejoin="round" stroke-width=".38">
-<path d="M27.364 12.94v3.1M20 9v8.1M12.578 11.94v4.1"/>
-</g>
-<rect width="20.063" height="14.331" x="9.968" y="14.969" fill="#505050" rx="1.66" ry="1.66"/>
-<rect width="20.063" height="14.331" x="9.968" y="14.969" fill="#484848" fill-opacity=".953" filter="url(#b)" rx="1.66" ry="1.66"/>
-<rect width="18.339" height="12.762" x="10.83" y="15.754" fill="#3d3d3d" rx=".42" ry=".42"/>
-<path fill="none" stroke="#ff6f00" stroke-linecap="round" stroke-linejoin="round" stroke-width=".24" d="M18.222 17.496h-6.35"/>
-<rect width="7.365" height="5.758" x="20.885" y="16.897" fill="#a1a1a1" rx=".4" ry=".4"/>
-<path fill="#ff6f00" d="M25.399 18.297c.367 0 2.242 3.657 2.058 3.975-.183.318-5.797.318-5.98 0-.184-.318 3.555-3.975 3.922-3.975z"/>
-<g fill="none" stroke="#ff6f00" stroke-linecap="round" stroke-linejoin="round" stroke-width=".24">
-<path d="M17.163 19.437h-5.292M17.163 20.437h-5.292M15.047 21.437h-3.175"/>
-</g>
-<path fill="#a1a1a1" d="M11.848 25.486a.099.099 0 0 0-.098.1v2.929h.183V25.68c0-.014.012-.025.025-.025h16.083c.014 0 .025.011.025.025v2.834h.183v-2.928c0-.056-.043-.1-.097-.1z"/>
-<path fill="#505050" d="M11.958 25.656a.025.025 0 0 0-.025.025v2.839h16.133V25.68a.025.025 0 0 0-.024-.025z"/>
-<g fill="none" stroke="#ff6f00" stroke-linecap="round" stroke-linejoin="round">
-<g stroke-width=".2">
-<path d="M15.124 26.486h-2.117M17.77 26.486h-1.587M16.912 28.074h-2.117M15.653 27.245h-1.587"/>
-</g>
-<path stroke-width=".24" d="M17.163 24.671h-5.292"/>
-<path stroke-width=".2" d="M20.416 26.486h-1.587"/>
-</g>
-</svg>
+++ /dev/null
-antoraVersion: '1.0.0'
-site:
- url: http://localhost:5252
- title: Brand Docs
- components:
- - name: abc
- title: Project ABC
- url: '#'
- versions:
- - &latest_version_abc
- url: '#'
- version: '1.1'
- displayVersion: '1.1'
- - url: '#'
- version: '1.0'
- displayVersion: '1.0'
- latestVersion: *latest_version_abc
- - &component
- name: xyz
- title: Project XYZ
- url: /xyz/6.0/index.html
- versions:
- - &latest_version_xyz
- url: /xyz/6.0/index.html
- version: '6.0'
- displayVersion: '6.0'
- - &component_version
- url: '#'
- version: '5.2'
- displayVersion: '5.2'
- - url: '#'
- version: '5.1'
- displayVersion: '5.1'
- - url: '#'
- version: '5.0'
- displayVersion: '5.0'
- latestVersion: *latest_version_xyz
- - name: 123
- title: Project 123
- url: '#'
- versions:
- - &latest_version_123
- url: '#'
- version: '2.2'
- displayVersion: '2.2'
- - url: '#'
- version: '2.1'
- displayVersion: '2.1'
- - url: '#'
- version: '2.0'
- displayVersion: '2.0'
- latestVersion: *latest_version_123
-page:
- title: Brand’s Hardware & Software Requirements
- url: /xyz/5.2/index.html
- component: *component
- componentVersion: *component_version
- version: '5.2'
- displayVersion: '5.2'
- module: ROOT
- home: false
- editUrl: http://example.com/project-xyz/blob/master/index.adoc
- origin:
- private: false
- breadcrumbs:
- - content: Quickstart
- url: '#'
- urlType: fragment
- - content: Brand’s Hardware & Software Requirements
- url: /xyz/5.2/index.html
- urlType: internal
- versions:
- - version: '6.0'
- displayVersion: '6.0'
- url: '#'
- - version: '5.2'
- displayVersion: '5.2'
- url: '#'
- - version: '5.1'
- displayVersion: '5.1'
- url: '#'
- - version: '5.0'
- displayVersion: '5.0'
- missing: true
- url: '#'
- navigation:
- - root: true
- content: Project XYZ
- url: '#'
- urlType: fragment
- items:
- - content: Quickstart
- url: '#'
- urlType: fragment
- items:
- - content: Brand’s Hardware & Software Requirements
- url: /xyz/5.2/index.html
- urlType: internal
- - content: IDE Integration
- url: '#'
- urlType: fragment
- - content: Liber Recusabo
- url: '#liber-recusabo'
- urlType: fragment
- - content: Reference
- items:
- - content: Keyboard Shortcuts
- url: '#'
- urlType: fragment
- - content: Importing and Exporting
- url: '#'
- urlType: fragment
+++ /dev/null
-html,
-body {
- height: 100%;
-}
-
-*,
-*::before,
-*::after {
- box-sizing: inherit;
-}
-
-html {
- box-sizing: border-box;
- font-size: var(--body-font-size);
- -webkit-text-size-adjust: 100%;
-}
-
-@media screen and (min-width: 1024px) {
- html {
- font-size: var(--body-font-size--desktop);
- }
-}
-
-body {
- background: var(--body-background);
- color: var(--body-font-color);
- font-family: var(--body-font-family);
- line-height: var(--body-line-height);
- margin: 0;
-}
-
-a {
- text-decoration: none;
-}
-
-a:hover {
- text-decoration: underline;
-}
-
-code,
-kbd,
-pre {
- font-family: var(--monospace-font-family);
-}
-
-b,
-dt,
-strong,
-th {
- font-weight: var(--body-font-weight-bold);
-}
-
-em em { /* stylelint-disable-line */
- font-style: normal;
-}
-
-strong strong { /* stylelint-disable-line */
- font-weight: normal;
-}
-
-button {
- cursor: pointer;
- font-family: inherit;
- font-size: 1em;
- line-height: var(--body-line-height);
- margin: 0;
-}
-
-button::-moz-focus-inner {
- border: none;
- padding: 0;
-}
+++ /dev/null
-@media screen and (min-width: 1024px) {
- .body {
- display: flex;
- }
-}
+++ /dev/null
-.breadcrumbs {
- display: none;
- flex: 1 1;
- padding: 0 0.5rem 0 0.75rem;
- line-height: var(--nav-line-height);
-}
-
-@media screen and (min-width: 1024px) {
- .breadcrumbs {
- display: block;
- }
-}
-
-a + .breadcrumbs {
- padding-left: 0.05rem;
-}
-
-.breadcrumbs ul {
- display: flex;
- flex-wrap: wrap;
- margin: 0;
- padding: 0;
- list-style: none;
-}
-
-.breadcrumbs li {
- display: inline;
- margin: 0;
-}
-
-.breadcrumbs li::after {
- content: "/";
- padding: 0 0.5rem;
-}
-
-.breadcrumbs li:last-of-type::after {
- content: none;
-}
+++ /dev/null
-.doc {
- color: var(--doc-font-color);
- font-size: var(--doc-font-size);
- line-height: var(--doc-line-height);
- margin: var(--doc-margin);
- max-width: var(--doc-max-width);
- padding: 0 1rem 4rem;
-}
-
-@media screen and (min-width: 1024px) {
- .doc {
- font-size: var(--doc-font-size--desktop);
- margin: var(--doc-margin--desktop);
- max-width: var(--doc-max-width--desktop);
- }
-}
-
-.doc h1,
-.doc h2,
-.doc h3,
-.doc h4,
-.doc h5,
-.doc h6 {
- color: var(--heading-font-color);
- font-weight: var(--heading-font-weight);
- line-height: 1.3;
- margin: 1rem 0 0;
-}
-
-.doc > h1.page:first-child {
- font-size: calc(36 / var(--rem-base) * 1rem);
- margin: 1.5rem 0;
-}
-
-@media screen and (min-width: 769px) {
- .doc > h1.page:first-child {
- margin-top: 2.5rem;
- }
-}
-
-#preamble + .sect1,
-.doc .sect1 + .sect1 {
- margin-top: 2rem;
-}
-
-.doc h2:not(.discrete) {
- border-bottom: 1px solid var(--section-divider-color);
- margin-left: -1rem;
- margin-right: -1rem;
- padding: 0.4rem 1rem 0.1rem;
-}
-
-.doc h3:not(.discrete) {
- font-weight: var(--alt-heading-font-weight);
-}
-
-.doc h1 .anchor,
-.doc h2 .anchor,
-.doc h3 .anchor,
-.doc h4 .anchor,
-.doc h5 .anchor,
-.doc h6 .anchor {
- position: absolute;
- text-decoration: none;
- width: 1.75ex;
- margin-left: -1.5ex;
- visibility: hidden;
- font-size: 0.8em;
- font-weight: normal;
- padding-top: 0.05em;
-}
-
-.doc h1 .anchor::before,
-.doc h2 .anchor::before,
-.doc h3 .anchor::before,
-.doc h4 .anchor::before,
-.doc h5 .anchor::before,
-.doc h6 .anchor::before {
- content: "\00a7";
-}
-
-.doc h1:hover .anchor,
-.doc h2:hover .anchor,
-.doc h3:hover .anchor,
-.doc h4:hover .anchor,
-.doc h5:hover .anchor,
-.doc h6:hover .anchor {
- visibility: visible;
-}
-
-.doc p {
- margin: 0;
-}
-
-.doc .tableblock p {
- font-size: inherit;
-}
-
-.doc p,
-.doc :not(td) > .content,
-.doc .tableblock thead {
- hyphens: auto;
-}
-
-.doc a {
- color: var(--link-font-color);
-}
-
-.doc a:hover {
- color: var(--link_hover-font-color);
-}
-
-.doc a.bare {
- hyphens: none;
-}
-
-.doc a.unresolved {
- color: var(--link_unresolved-font-color);
-}
-
-.doc i.fa {
- font-style: normal;
-}
-
-.doc p code,
-.doc thead code {
- color: var(--code-font-color);
- background: var(--code-background);
- border-radius: 0.25em;
- font-size: 0.95em;
- padding: 0.125em 0.25em;
-}
-
-.doc pre {
- font-size: calc(16 / var(--rem-base) * 1rem);
- line-height: 1.5;
- margin: 0;
-}
-
-.doc blockquote {
- margin: 0;
-}
-
-.doc .right {
- float: right;
-}
-
-.doc .left {
- float: left;
-}
-
-.doc .underline {
- text-decoration: underline;
-}
-
-.doc .line-through {
- text-decoration: line-through;
-}
-
-.doc .paragraph,
-.doc .dlist,
-.doc .olist,
-.doc .ulist,
-.doc .exampleblock,
-.doc .imageblock,
-.doc .listingblock,
-.doc .literalblock,
-.doc .sidebarblock,
-.doc .verseblock,
-.doc .quoteblock {
- margin: 1rem 0 0;
-}
-
-.doc table.tableblock {
- border-collapse: collapse;
- font-size: calc(15 / var(--rem-base) * 1rem);
- margin: 2rem 0;
- /* enable table-layout: fixed if you want the table width to be enforced strictly */
- /* alternative is to wrap table in div and set overflow-x: auto on the wrapper */
- /* table-layout: fixed; */
-}
-
-.doc table.stretch {
- width: 100%;
-}
-
-.doc table.tableblock thead th {
- border-bottom: 2.5px solid var(--table-border-color);
- padding: 0.5rem;
-}
-
-.doc table.tableblock td,
-.doc table.tableblock > :not(thead) th {
- border-top: 1px solid var(--table-border-color);
- border-bottom: 1px solid var(--table-border-color);
- padding: 0.5rem;
-}
-
-.doc .halign-left {
- text-align: left;
-}
-
-.doc .halign-right {
- text-align: right;
-}
-
-.doc .halign-center {
- text-align: center;
-}
-
-.doc .valign-top {
- vertical-align: top;
-}
-
-.doc .valign-bottom {
- vertical-align: bottom;
-}
-
-.doc .valign-middle {
- vertical-align: middle;
-}
-
-.doc .admonitionblock {
- margin: 1.4rem 0 0;
-}
-
-.doc .admonitionblock p,
-.doc .admonitionblock td.content {
- font-size: calc(16 / var(--rem-base) * 1rem);
-}
-
-.doc .admonitionblock td.content > :first-child {
- margin: 0;
-}
-
-.doc .admonitionblock pre {
- font-size: calc(15 / var(--rem-base) * 1rem);
-}
-
-.doc .admonitionblock > table {
- border-collapse: collapse;
- table-layout: fixed;
- position: relative;
- width: 100%;
-}
-
-.doc .admonitionblock td.content {
- padding: 1rem 1rem 0.75rem;
- background: var(--admonition-background);
- width: 100%;
-}
-
-.doc .admonitionblock .icon {
- position: absolute;
- top: 0;
- left: 0;
- font-size: calc(15 / var(--rem-base) * 1rem);
- padding: 0 0.5rem;
- height: 1.25rem;
- line-height: 1;
- font-weight: var(--admonition-label-font-weight);
- text-transform: uppercase;
- border-radius: 0.45rem;
- transform: translate(-0.5rem, -50%);
-}
-
-.doc .admonitionblock.caution .icon {
- background-color: var(--caution-color);
- color: var(--caution-on-color);
-}
-
-.doc .admonitionblock.important .icon {
- background-color: var(--important-color);
- color: var(--important-on-color);
-}
-
-.doc .admonitionblock.note .icon {
- background-color: var(--note-color);
- color: var(--note-on-color);
-}
-
-.doc .admonitionblock.tip .icon {
- background-color: var(--tip-color);
- color: var(--tip-on-color);
-}
-
-.doc .admonitionblock.warning .icon {
- background-color: var(--warning-color);
- color: var(--warning-on-color);
-}
-
-.doc .admonitionblock .icon i {
- display: inline-flex;
- align-items: center;
- height: 100%;
-}
-
-.doc .admonitionblock .icon i::after {
- content: attr(title);
- hyphens: none;
-}
-
-.doc .imageblock {
- display: flex;
- flex-direction: column;
- align-items: center;
-}
-
-.doc .imageblock img {
- display: block;
-}
-
-.doc .imageblock img,
-.doc .image > img {
- height: auto;
- max-width: 100%;
-}
-
-#preamble .abstract blockquote {
- background: var(--abstract-background);
- border-left: 5px solid var(--abstract-border-color);
- color: var(--abstract-font-color);
- font-size: calc(16 / var(--rem-base) * 1rem);
- padding: 0.75em 1em;
-}
-
-.doc .quoteblock {
- background: var(--quote-background);
- border-left: 5px solid var(--quote-border-color);
- color: var(--quote-font-color);
- padding: 0.25rem 2rem 1.25rem;
-}
-
-.doc .quoteblock .attribution {
- color: var(--quote-attribution-font-color);
- font-size: calc(15 / var(--rem-base) * 1rem);
- margin-top: 0.75rem;
-}
-
-.doc .quoteblock blockquote {
- margin-top: 1rem;
-}
-
-.doc .quoteblock .paragraph {
- font-style: italic;
-}
-
-.doc .quoteblock cite {
- padding-left: 1em;
-}
-
-.doc table.tableblock .paragraph {
- margin: 0;
- padding: 0;
-}
-
-.doc table.tableblock .admonitionblock,
-.doc .ulist .admonitionblock,
-.doc .olist .admonitionblock {
- padding: 0;
-}
-
-.doc ol,
-.doc ul {
- margin: 0;
- padding: 0 0 0 2rem;
-}
-
-.doc ol.arabic {
- list-style-type: decimal;
-}
-
-.doc ol.decimal {
- list-style-type: decimal-leading-zero;
-}
-
-.doc ol.loweralpha {
- list-style-type: lower-alpha;
-}
-
-.doc ol.upperalpha {
- list-style-type: upper-alpha;
-}
-
-.doc ol.lowerroman {
- list-style-type: lower-roman;
-}
-
-.doc ol.upperroman {
- list-style-type: upper-roman;
-}
-
-.doc ol.lowergreek {
- list-style-type: lower-greek;
-}
-
-.doc ul.checklist {
- padding-left: 0.5rem;
- list-style: none;
-}
-
-.doc ul.checklist p > i.fa-check-square-o:first-child,
-.doc ul.checklist p > i.fa-square-o:first-child {
- display: inline-flex;
- justify-content: center;
- width: 1.25rem;
-}
-
-.doc ul.checklist i.fa-check-square-o::before {
- content: "\2713";
-}
-
-.doc ul.checklist i.fa-square-o::before {
- content: "\274f";
-}
-
-.doc .dlist .dlist,
-.doc .dlist .olist,
-.doc .dlist .ulist,
-.doc .olist .dlist,
-.doc .olist .olist,
-.doc .olist .ulist,
-.doc .ulist .dlist,
-.doc .ulist .olist,
-.doc .ulist .ulist {
- margin-top: 0.5rem;
-}
-
-.doc .olist li,
-.doc .ulist li {
- margin-bottom: 0.5rem;
-}
-
-.doc .ulist .listingblock,
-.doc .olist .listingblock,
-.doc .admonitionblock .listingblock {
- padding: 0;
-}
-
-.doc .admonitionblock .title,
-.doc .exampleblock .title,
-.doc .imageblock .title,
-.doc .literalblock .title,
-.doc .listingblock .title,
-.doc .openblock .title,
-.doc .tableblock caption {
- color: var(--caption-font-color);
- font-size: calc(16 / var(--rem-base) * 1rem);
- font-weight: var(--caption-font-weight);
- font-style: italic;
- letter-spacing: 0.01em;
- padding-bottom: 0.075rem;
- text-align: left;
-}
-
-.doc .imageblock .title {
- margin-top: 0.5rem;
- padding-bottom: 0;
-}
-
-.doc .admonitionblock .title + .paragraph {
- margin-top: 0;
-}
-
-.doc .exampleblock > .content {
- background: var(--example-background);
- border: 0.25rem solid var(--example-border-color);
- border-radius: 0.5rem;
- padding: 0.75rem;
-}
-
-.doc .exampleblock > .content > :first-child {
- margin-top: 0;
-}
-
-.doc .sidebarblock {
- background: var(--sidebar-background);
- border-radius: 0.75rem;
- padding: 0.75rem 1.5rem;
-}
-
-.doc .sidebarblock > .content > .title {
- font-size: calc(22.5 / var(--rem-base) * 1rem);
- font-weight: var(--alt-heading-font-weight);
- line-height: 1.3;
- margin-bottom: -0.3em;
- text-align: center;
-}
-
-.doc .sidebarblock > .content > :not(.title):first-child {
- margin-top: 0;
-}
-
-/* NEEDS REVIEW prevent pre in table from causing article to exceed bounds */
-.doc .tableblock pre,
-.doc .listingblock.wrap pre {
- white-space: pre-wrap;
-}
-
-.doc pre:not(.highlight),
-.doc pre.highlight code {
- background: var(--pre-background);
- box-shadow: inset 0 0 1.75px var(--pre-border-color);
- display: block;
- overflow-x: auto;
- padding: 0.75rem;
-}
-
-/* NOTE assume pre.highlight contains code[data-lang] */
-.doc pre.highlight {
- position: relative;
-}
-
-.doc .listingblock code[data-lang]::before {
- content: attr(data-lang);
- display: none;
- color: var(--pre-annotation-font-color);
- font-size: calc(13.5 / var(--rem-base) * 1rem);
- letter-spacing: 0.05em;
- line-height: 1;
- text-transform: uppercase;
- position: absolute;
- top: 0.25rem;
- right: 0.25rem;
-}
-
-.doc .listingblock:hover code[data-lang]::before {
- display: block;
-}
-
-.doc .dlist dt {
- font-style: italic;
-}
-
-.doc .dlist dd {
- margin: 0 0 0.3rem 1.5rem;
-}
-
-.doc .colist {
- font-size: calc(16 / var(--rem-base) * 1rem);
- margin-top: 0.5rem;
-}
-
-.doc .colist > table tr > td:first-of-type {
- padding: 0 0.75em;
- line-height: 1;
-}
-
-.doc .conum[data-value] {
- border: 1px solid currentColor;
- border-radius: 100%;
- display: inline-block;
- font-family: var(--body-font-family);
- font-size: calc(13.5 / var(--rem-base) * 1rem);
- font-style: normal;
- height: 1.25em;
- line-height: 1.2;
- text-align: center;
- width: 1.25em;
- letter-spacing: -0.25ex;
- text-indent: -0.25ex;
-}
-
-.doc .conum[data-value]::after {
- content: attr(data-value);
-}
-
-.doc .conum[data-value] + b {
- display: none;
-}
-
-.doc b.button {
- white-space: nowrap;
-}
-
-.doc b.button::before {
- content: "[";
- padding-right: 0.25em;
-}
-
-.doc b.button::after {
- content: "]";
- padding-left: 0.25em;
-}
-
-.doc kbd {
- display: inline-block;
- font-size: calc(12 / var(--rem-base) * 1rem);
- background: var(--kbd-background);
- border: 1px solid var(--kbd-border-color);
- border-radius: 0.25em;
- box-shadow: 0 1px 0 var(--kbd-border-color), 0 0 0 0.1em var(--body-background) inset;
- padding: 0.25em 0.5em;
- vertical-align: text-bottom;
- white-space: nowrap;
-}
-
-.doc kbd,
-.doc .keyseq {
- line-height: 1;
-}
-
-.doc .keyseq {
- font-size: calc(16 / var(--rem-base) * 1rem);
-}
-
-.doc .keyseq kbd {
- margin: 0 0.125em;
-}
-
-.doc .keyseq kbd:first-child {
- margin-left: 0;
-}
-
-.doc .keyseq kbd:last-child {
- margin-right: 0;
-}
-
-.doc .menuseq i.caret::before {
- content: "\203a";
- font-size: 1.1em;
- font-weight: var(--body-font-weight-bold);
- line-height: calc(1 / 1.1);
-}
+++ /dev/null
-footer.footer {
- background-color: var(--footer-background);
- color: var(--footer-font-color);
- font-size: calc(15 / var(--rem-base) * 1rem);
- line-height: var(--footer-line-height);
- padding: 1.5rem;
-}
-
-.footer p {
- margin: 0.5rem 0;
-}
-
-.footer a {
- color: var(--footer-link-font-color);
-}
-
-.article-footer {
- width: 100%;
-}
-
-.article-footer .article-footer-next {
- float: right;
- width: 35%;
- text-align: right;
-}
-
-.article-footer .article-footer-previous {
- float: left;
- width: 35%;
-}
+++ /dev/null
-html.is-clipped--navbar {
- overflow-y: hidden;
-}
-
-body {
- padding-top: var(--navbar-height);
-}
-
-.navbar {
- background: var(--navbar-background);
- color: var(--navbar-font-color);
- font-size: calc(16 / var(--rem-base) * 1rem);
- height: var(--navbar-height);
- position: fixed;
- top: 0;
- width: 100%;
- word-wrap: break-word;
- z-index: var(--z-index-navbar);
-}
-
-.navbar a {
- text-decoration: none;
-}
-
-.navbar-brand .navbar-item:first-child,
-.navbar-brand .navbar-item:first-child a {
- color: var(--navbar-font-color);
- font-size: calc(22 / var(--rem-base) * 1rem);
-}
-
-.navbar-brand .separator {
- padding: 0 0.375rem;
-}
-
-@media screen and (min-width: 1024px) {
- .navbar-end > .navbar-item,
- .navbar-end .navbar-link {
- color: var(--navbar-font-color);
- }
-
- .navbar-end > a.navbar-item:hover,
- .navbar-end .navbar-link:hover {
- background: var(--navbar_hover-background);
- color: var(--navbar-font-color);
- }
-
- .navbar-end .navbar-link::after {
- border-color: var(--navbar-font-color);
- }
-
- .navbar-item.has-dropdown:hover .navbar-link {
- background: var(--navbar_hover-background);
- color: var(--navbar-font-color);
- }
-}
-
-.navbar-brand {
- align-items: stretch;
- display: flex;
- flex-shrink: 0;
- height: var(--navbar-height);
-}
-
-.navbar-burger {
- color: var(--navbar-font-color);
- background: none;
- border: none;
- outline: none;
- line-height: 1;
- height: var(--navbar-height);
- position: relative;
- /* width: var(--navbar-height); */
- width: 2.75rem;
- margin-left: auto;
- padding: 0;
-}
-
-.navbar-burger span {
- background: var(--navbar-font-color);
- display: block;
- height: 1px;
- left: 50%;
- margin-left: -7px;
- position: absolute;
- top: 50%;
- width: 15px;
-}
-
-.navbar-burger span:nth-child(1) {
- margin-top: -6px;
-}
-
-.navbar-burger span:nth-child(2) {
- margin-top: -1px;
-}
-
-.navbar-burger span:nth-child(3) {
- margin-top: 4px;
-}
-
-.navbar-burger.is-active span:nth-child(1) {
- margin-left: -5px;
- transform: rotate(45deg);
- transform-origin: left top;
-}
-
-.navbar-burger.is-active span:nth-child(2) {
- opacity: 0;
-}
-
-.navbar-burger.is-active span:nth-child(3) {
- margin-left: -5px;
- transform: rotate(-45deg);
- transform-origin: left bottom;
-}
-
-.navbar-menu {
- display: none;
-}
-
-.navbar-item,
-.navbar-link {
- color: var(--navbar-menu-font-color);
- display: block;
- line-height: var(--doc-line-height);
- padding: 0.5rem 1rem;
- position: relative;
-}
-
-.navbar-item {
- flex: none;
-}
-
-.navbar-item.has-dropdown {
- padding: 0;
-}
-
-.navbar-item .icon {
- width: 1.1rem;
- height: 1.1rem;
- display: block;
-}
-
-.navbar-link {
- padding-right: 2.5em;
-}
-
-.navbar-dropdown .navbar-item {
- padding-left: 1.5rem;
- padding-right: 1.5rem;
-}
-
-.navbar-divider {
- background-color: var(--navbar-menu-border-color);
- border: none;
- height: 1px;
- margin: 0.25rem 0;
-}
-
-@media screen and (max-width: 1023px) {
- .navbar-brand .navbar-item {
- align-items: center;
- display: flex;
- }
-
- .navbar-menu {
- background: var(--navbar-menu-background);
- padding: 0.5rem 0;
- }
-
- .navbar-menu.is-active {
- display: block;
- box-shadow: 0 8px 16px rgba(10, 10, 10, 0.1);
- max-height: var(--nav-height);
- overflow-y: auto;
- }
-
- .navbar-menu a.navbar-item:hover,
- .navbar-menu .navbar-link:hover {
- background-color: var(--navbar-menu_hover-background);
- }
-}
-
-@media screen and (min-width: 1024px) {
- .navbar,
- .navbar-menu,
- .navbar-end {
- align-items: stretch;
- display: flex;
- }
-
- .navbar-burger {
- display: none;
- }
-
- .navbar-item,
- .navbar-link {
- align-items: center;
- display: flex;
- }
-
- .navbar-item.has-dropdown {
- align-items: stretch;
- }
-
- .navbar-item.is-hoverable:hover .navbar-dropdown {
- display: block;
- }
-
- .navbar-link::after {
- border-width: 0 0 1px 1px;
- border-style: solid;
- content: " ";
- display: block;
- height: 0.5em;
- pointer-events: none;
- position: absolute;
- transform: rotate(-45deg);
- width: 0.5em;
- margin-top: -0.375em;
- right: 1.125em;
- top: 50%;
- }
-
- .navbar-menu {
- flex-grow: 1;
- }
-
- .navbar-end {
- justify-content: flex-end;
- margin-left: auto;
- }
-
- .navbar-dropdown {
- background-color: var(--navbar-menu-background);
- border: 1px solid var(--navbar-menu-border-color);
- border-top: none;
- border-radius: 0 0 0.25rem 0.25rem;
- display: none;
- top: 100%;
- left: 0;
- min-width: 100%;
- position: absolute;
- }
-
- .navbar-dropdown .navbar-item {
- padding: 0.5rem 1rem;
- white-space: nowrap;
- }
-
- .navbar-dropdown .navbar-item:last-child {
- border-radius: inherit;
- }
-
- .navbar-dropdown a.navbar-item {
- padding-right: 3rem;
- }
-
- .navbar-dropdown.is-right {
- left: auto;
- right: 0;
- }
-
- .navbar-dropdown a.navbar-item:hover {
- background-color: var(--navbar-menu_hover-background);
- }
-}
-
-.navbar .button {
- display: inline-flex;
- align-items: center;
- background: var(--navbar-button-background);
- border: 1px solid var(--navbar-button-border-color);
- border-radius: 0.15rem;
- height: 1.75rem;
- color: var(--navbar-button-font-color);
- padding: 0 0.75em;
- white-space: nowrap;
-}
+++ /dev/null
-/*! Adapted from the GitHub style by Vasily Polovnyov <vast@whiteants.net> */
-.hljs-comment,
-.hljs-quote {
- color: #998;
- font-style: italic;
-}
-
-.hljs-keyword,
-.hljs-selector-tag,
-.hljs-subst {
- color: #333;
- font-weight: var(--monospace-font-weight-bold);
-}
-
-.hljs-number,
-.hljs-literal,
-.hljs-variable,
-.hljs-template-variable,
-.hljs-tag .hljs-attr {
- color: #008080;
-}
-
-.hljs-string,
-.hljs-doctag {
- color: #d14;
-}
-
-.hljs-title,
-.hljs-section,
-.hljs-selector-id {
- color: #900;
- font-weight: var(--monospace-font-weight-bold);
-}
-
-.hljs-subst {
- font-weight: normal;
-}
-
-.hljs-type,
-.hljs-class .hljs-title {
- color: #458;
- font-weight: var(--monospace-font-weight-bold);
-}
-
-.hljs-tag,
-.hljs-name,
-.hljs-attribute {
- color: #000080;
- font-weight: normal;
-}
-
-.hljs-regexp,
-.hljs-link {
- color: #009926;
-}
-
-.hljs-symbol,
-.hljs-bullet {
- color: #990073;
-}
-
-.hljs-built_in,
-.hljs-builtin-name {
- color: #0086b3;
-}
-
-.hljs-meta {
- color: #999;
- font-weight: var(--monospace-font-weight-bold);
-}
-
-.hljs-deletion {
- background: #fdd;
-}
-
-.hljs-addition {
- background: #dfd;
-}
-
-.hljs-emphasis {
- font-style: italic;
-}
-
-.hljs-strong {
- font-weight: var(--monospace-font-weight-bold);
-}
+++ /dev/null
-@media screen and (min-width: 1024px) {
- main {
- flex: auto;
- /* min-width: 0 required for flexbox to constrain overflowing elements */
- min-width: 0;
- }
-}
+++ /dev/null
-.nav-container {
- position: fixed;
- top: var(--navbar-height);
- left: 0;
- width: 100%;
- font-size: calc(17 / var(--rem-base) * 1rem);
- z-index: var(--z-index-nav);
- visibility: hidden;
-}
-
-@media screen and (min-width: 769px) {
- .nav-container {
- width: var(--nav-width);
- }
-}
-
-@media screen and (min-width: 1024px) {
- .nav-container {
- font-size: calc(15.5 / var(--rem-base) * 1rem);
- flex: none;
- position: static;
- top: 0;
- visibility: visible;
- }
-}
-
-.nav-container.is-active {
- visibility: visible;
-}
-
-.nav {
- background: var(--nav-background);
- position: relative;
- top: var(--toolbar-height);
- height: var(--nav-height);
-}
-
-@media screen and (min-width: 769px) {
- .nav {
- box-shadow: 0.5px 0 3px var(--nav-border-color);
- }
-}
-
-@media screen and (min-width: 1024px) {
- .nav {
- top: var(--navbar-height);
- box-shadow: none;
- position: sticky;
- height: var(--nav-height--desktop);
- }
-}
-
-.nav .panels {
- display: flex;
- flex-direction: column;
- height: inherit;
-}
-
-html.is-clipped--nav {
- overflow-y: hidden;
-}
-
-.nav-panel-menu {
- overflow-y: auto;
- display: flex;
- flex-direction: column;
- height: var(--nav-panel-height);
-}
-
-@media screen and (min-width: 1024px) {
- .nav-panel-menu {
- height: var(--nav-panel-height--desktop);
- }
-}
-
-.nav-panel-menu:not(.is-active) .nav-menu {
- opacity: 0.75;
-}
-
-.nav-panel-menu:not(.is-active)::after {
- content: "";
- background: rgba(0, 0, 0, 0.5);
- display: block;
- position: absolute;
- top: 0;
- right: 0;
- bottom: 0;
- left: 0;
-}
-
-.nav-panel-menu::-webkit-scrollbar {
- width: 0.25rem;
-}
-
-.nav-panel-menu::-webkit-scrollbar-thumb {
- background-color: var(--nav-border-color);
-}
-
-.nav-menu {
- flex-grow: 1;
- min-height: 0;
- width: 100%;
- padding: 0.5rem 0.75rem;
- line-height: var(--nav-line-height);
- position: relative;
-}
-
-.nav-menu h3.title {
- color: var(--nav-heading-font-color);
- font-size: inherit;
- font-weight: var(--body-font-weight-bold);
- margin: 0;
- padding: 0.25em 0 0.125em;
-}
-
-.nav-menu a {
- color: inherit;
-}
-
-.nav-list {
- margin: 0 0 0 0.75rem;
- padding: 0;
-}
-
-.nav-menu > .nav-list {
- margin-bottom: 0.5rem;
-}
-
-.nav-item {
- list-style: none;
- margin-top: 0.5em;
-}
-
-/* adds some breathing room below a nested list */
-.nav-item-toggle ~ .nav-list {
- padding-bottom: 0.125rem;
-}
-
-/* matches list without a title */
-.nav-item[data-depth="0"] > .nav-list:first-child {
- display: block;
- margin: 0;
-}
-
-.nav-item:not(.is-active) > .nav-list {
- display: none;
-}
-
-.nav-item-toggle {
- background: transparent url(../img/caret.svg) no-repeat center / 50%;
- border: none;
- outline: none;
- line-height: inherit;
- position: absolute;
- height: calc(var(--nav-line-height) * 1em);
- width: calc(var(--nav-line-height) * 1em);
- margin-top: -0.05em;
- margin-left: calc(var(--nav-line-height) * -1em);
-}
-
-.nav-item.is-active > .nav-item-toggle {
- transform: rotate(90deg);
-}
-
-.is-current-page > .nav-link,
-.is-current-page > .nav-text {
- font-weight: var(--body-font-weight-bold);
-}
-
-.nav-panel-explore {
- background: var(--nav-background);
- display: flex;
- flex-direction: column;
- position: absolute;
- right: 0;
- bottom: 0;
- left: 0;
- max-height: calc(50% + var(--drawer-height));
-}
-
-.nav-panel-explore .context {
- font-size: calc(15 / var(--rem-base) * 1rem);
- flex-shrink: 0;
- color: var(--nav-muted-color);
- box-shadow: 0 -1px 0 var(--nav-panel-divider-color);
- padding: 0 0.25rem 0 0.5rem;
- display: flex;
- align-items: center;
- justify-content: space-between;
- cursor: pointer;
- line-height: 1;
- height: var(--drawer-height);
-}
-
-.nav-panel-explore .context .version {
- background-image: url(../img/chevron.svg);
- background-repeat: no-repeat;
- background-position: right 0.5rem top 50%;
- background-size: auto 0.75em;
- padding: 0 1.5rem 0 0;
-}
-
-.nav-panel-explore .components {
- line-height: var(--doc-line-height);
- flex-grow: 1;
- box-shadow: inset 0 1px 5px var(--nav-panel-divider-color);
- background: var(--nav-secondary-background);
- padding: 0.5rem 0.75rem 0 0.75rem;
- margin: 0;
- overflow-y: auto;
- max-height: 100%;
- display: block;
-}
-
-.nav-panel-explore:not(.is-active) .components {
- display: none;
-}
-
-.nav-panel-explore .component {
- display: block;
-}
-
-.nav-panel-explore .component + .component {
- margin-top: 0.5rem;
-}
-
-.nav-panel-explore .component:last-child {
- margin-bottom: 0.75rem;
-}
-
-.nav-panel-explore .component .title {
- font-weight: var(--body-font-weight-bold);
-}
-
-.nav-panel-explore .versions {
- display: flex;
- flex-wrap: wrap;
- list-style: none;
- padding-left: 0;
- margin-top: -0.25rem;
- line-height: 1;
-}
-
-.nav-panel-explore .component .version {
- display: block;
- margin: 0.375rem 0.375rem 0 0;
-}
-
-.nav-panel-explore .component .version a {
- border: 1px solid var(--nav-border-color);
- border-radius: 0.25rem;
- color: inherit;
- opacity: 0.75;
- white-space: nowrap;
- padding: 0.125em 0.25em;
- display: inherit;
-}
-
-.nav-panel-explore .component .is-current a {
- border-color: currentColor;
- opacity: 0.9;
- font-weight: var(--body-font-weight-bold);
-}
-
-/*
-.nav-panel-explore .component .is-latest a::after {
- content: " (latest)";
-}
-*/
+++ /dev/null
-.page-versions {
- display: none;
- margin-right: 0.7rem;
- position: relative;
- line-height: 1;
-}
-
-@media screen and (min-width: 1024px) {
- .page-versions {
- display: block;
- }
-}
-
-.page-versions .version-menu-toggle {
- color: inherit;
- background: url(../img/chevron.svg) no-repeat;
- background-position: right 0.5rem top 50%;
- background-size: auto 0.75em;
- border: none;
- outline: none;
- line-height: inherit;
- padding: 0.5rem 1.5rem 0.5rem 0.5rem;
- position: relative;
- z-index: var(--z-index-page-version-menu);
-}
-
-.page-versions .version-menu {
- border: 1px solid transparent;
- background-color: var(--page-version-menu-background);
- padding: 1.25rem 0.5rem 0.5rem;
- position: absolute;
- top: 0;
- left: 0;
- width: 100%;
-}
-
-.page-versions:not(.is-active) .version-menu {
- display: none;
-}
-
-.page-versions .version {
- display: block;
- padding-top: 0.5rem;
-}
-
-.page-versions .version.is-current {
- display: none;
-}
-
-.page-versions .version.is-missing {
- color: var(--page-version-missing-font-color);
- font-style: italic;
- text-decoration: none;
-}
+++ /dev/null
-@page {
- margin: 0.5in;
-}
-
-@media print {
- .hide-for-print {
- display: none !important;
- }
-
- html {
- font-size: var(--body-font-size--print);
- }
-
- a {
- color: inherit !important;
- text-decoration: underline;
- }
-
- a.bare,
- a[href^="#"],
- a[href^="mailto:"] {
- text-decoration: none;
- }
-
- tr,
- img,
- object,
- svg {
- page-break-inside: avoid;
- }
-
- thead {
- display: table-header-group;
- }
-
- pre {
- hyphens: none;
- white-space: pre-wrap;
- }
-
- body {
- padding-top: 2rem;
- }
-
- .navbar {
- background: none;
- color: inherit;
- position: absolute;
- }
-
- .navbar * {
- color: inherit !important;
- }
-
- #topbar-nav,
- .nav-container,
- .toolbar {
- display: none;
- }
-
- .doc {
- color: inherit;
- margin: auto;
- max-width: none;
- padding-bottom: 2rem;
- }
-
- .doc .listingblock code[data-lang]::before {
- display: block;
- }
-
- footer.footer {
- background: none;
- border-top: 1px solid var(--panel-border-color);
- color: var(--quote-attribution-font-color);
- padding: 0.5rem;
- }
-
- .footer * {
- color: inherit;
- }
-}
+++ /dev/null
-@import "typeface-roboto.css";
-@import "typeface-roboto-mono.css";
-@import "vars.css";
-@import "base.css";
-@import "body.css";
-@import "nav.css";
-@import "main.css";
-@import "toolbar.css";
-@import "breadcrumbs.css";
-@import "page-versions.css";
-@import "doc.css";
-@import "header.css";
-@import "footer.css";
-@import "highlight.css";
-@import "print.css";
+++ /dev/null
-.toolbar {
- color: var(--toolbar-font-color);
- align-items: center;
- background-color: var(--toolbar-background);
- box-shadow: 0 1px 0 var(--toolbar-border-color);
- display: flex;
- font-size: calc(15 / var(--rem-base) * 1rem);
- height: var(--toolbar-height);
- justify-content: flex-start;
- position: sticky;
- top: var(--navbar-height);
- z-index: var(--z-index-toolbar);
-}
-
-.toolbar a {
- color: inherit;
-}
-
-.nav-toggle {
- background: url(../img/menu.svg) no-repeat 50% 47.5%;
- background-size: 49%;
- border: none;
- outline: none;
- line-height: inherit;
- height: 2.5rem;
- padding: 0;
- width: 2.5rem;
- margin-right: -0.25rem;
-}
-
-@media screen and (min-width: 1024px) {
- .nav-toggle {
- display: none;
- }
-}
-
-.nav-toggle.is-active {
- background-image: url(../img/back.svg);
- background-size: 41.5%;
-}
-
-.home-link {
- background: url(../img/home-o.svg) no-repeat 50% 45%;
- background-size: 50%;
- display: block;
- height: 2.5rem;
- padding: 0;
- width: 2.5rem;
-}
-
-.home-link:hover,
-.home-link.is-current {
- background-image: url(../img/home.svg);
-}
-
-.edit-this-page {
- display: none;
- padding-right: 0.5rem;
-}
-
-@media screen and (min-width: 1024px) {
- .edit-this-page {
- display: block;
- }
-}
-
-.toolbar .edit-this-page a {
- color: var(--toolbar-muted-color);
-}
+++ /dev/null
-@font-face {
- font-family: "Roboto Mono";
- font-style: normal;
- font-weight: 400;
- src:
- local("Roboto Mono"),
- local("RobotoMono-Regular"),
- url(~typeface-roboto-mono/files/roboto-mono-latin-400.woff2) format("woff2"),
- url(~typeface-roboto-mono/files/roboto-mono-latin-400.woff) format("woff");
-}
-
-@font-face {
- font-family: "Roboto Mono";
- font-style: normal;
- font-weight: 500;
- src:
- local("Roboto Mono Medium"),
- local("RobotoMono-Medium"),
- url(~typeface-roboto-mono/files/roboto-mono-latin-500.woff2) format("woff2"),
- url(~typeface-roboto-mono/files/roboto-mono-latin-500.woff) format("woff");
-}
+++ /dev/null
-@font-face {
- font-family: "Roboto";
- font-style: normal;
- font-weight: 400;
- src:
- local("Roboto Regular"),
- local("Roboto-Regular"),
- url(~typeface-roboto/files/roboto-latin-400.woff2) format("woff2"),
- url(~typeface-roboto/files/roboto-latin-400.woff) format("woff");
-}
-
-@font-face {
- font-family: "Roboto";
- font-style: italic;
- font-weight: 400;
- src:
- local("Roboto Italic"),
- local("Roboto-Italic"),
- url(~typeface-roboto/files/roboto-latin-400italic.woff2) format("woff2"),
- url(~typeface-roboto/files/roboto-latin-400italic.woff) format("woff");
-}
-
-@font-face {
- font-family: "Roboto";
- font-style: normal;
- font-weight: 500;
- src:
- local("Roboto Medium"),
- local("Roboto-Medium"),
- url(~typeface-roboto/files/roboto-latin-500.woff2) format("woff2"),
- url(~typeface-roboto/files/roboto-latin-500.woff) format("woff");
-}
-
-@font-face {
- font-family: "Roboto";
- font-style: italic;
- font-weight: 500;
- src:
- local("Roboto Medium Italic"),
- local("Roboto-MediumItalic"),
- url(~typeface-roboto/files/roboto-latin-500italic.woff2) format("woff2"),
- url(~typeface-roboto/files/roboto-latin-500italic.woff) format("woff");
-}
+++ /dev/null
-:root {
- /* colors */
- --color-white: #fff;
- --color-smoke-10: #fefefe;
- --color-smoke-30: #fafafa;
- --color-smoke-50: #f5f5f5;
- --color-smoke-70: #f0f0f0;
- --color-smoke-90: #e1e1e1;
- --color-gray-10: #c1c1c1;
- --color-gray-30: #8e8e8e;
- --color-gray-50: #808080;
- --color-gray-70: #5d5d5d;
- --color-jet-20: #4a4a4a;
- --color-jet-30: #424242;
- --color-jet-50: #333;
- --color-jet-70: #222;
- --color-jet-80: #191919;
- --color-black: #000;
- --color-evergreen: #446129;
- /* fonts */
- --rem-base: 16; /* used to compute rem value from desired pixel value (e.g., calc(18 / var(--rem-base) * 1rem) = 18px) */
- --body-font-size: 1.0625em; /* 17px */
- --body-font-size--desktop: 1.125em; /* 18px */
- --body-font-size--print: 0.9375em; /* 15px */
- --body-line-height: 1.15;
- --body-font-color: var(--color-jet-70);
- --body-font-family: "Roboto", sans-serif;
- --body-font-weight-bold: 500;
- --monospace-font-family: "Roboto Mono", monospace;
- --monospace-font-weight-bold: 500;
- /* base */
- --body-background: var(--color-white);
- --panel-background: var(--color-smoke-30);
- --panel-border-color: var(--color-smoke-90);
- /* navbar */
- --navbar-background: var(--color-white);
- --navbar-font-color: var(--color-evergreen);
- --navbar_hover-background: var(--color-white);
- --navbar-button-background: var(--color-white);
- --navbar-button-border-color: var(--panel-border-color);
- --navbar-button-font-color: var(--color-evergreen);
- --navbar-menu-border-color: var(--panel-border-color);
- --navbar-menu-background: var(--color-white);
- --navbar-menu-font-color: var(--color-evergreen);
- --navbar-menu_hover-background: var(--color-smoke-50);
- /* nav */
- --nav-background: var(--panel-background);
- --nav-border-color: var(--color-gray-10);
- --nav-line-height: 1.35;
- --nav-heading-font-color: var(--color-jet-30);
- --nav-muted-color: var(--color-gray-70);
- --nav-panel-divider-color: var(--color-smoke-90);
- --nav-secondary-background: var(--color-smoke-70);
- /* toolbar */
- --toolbar-background: var(--panel-background);
- --toolbar-border-color: var(--panel-border-color);
- --toolbar-font-color: var(--color-gray-70);
- --toolbar-muted-color: var(--color-gray-30);
- --page-version-menu-background: var(--color-smoke-70);
- --page-version-missing-font-color: var(--color-gray-30);
- /* admonitions */
- --caution-color: #a0439c;
- --caution-on-color: var(--color-white);
- --important-color: #d32f2f;
- --important-on-color: var(--color-white);
- --note-color: #217ee7;
- --note-on-color: var(--color-white);
- --tip-color: #41af46;
- --tip-on-color: var(--color-white);
- --warning-color: #e18114;
- --warning-on-color: var(--color-white);
- /* doc */
- --doc-font-color: var(--color-jet-50);
- --doc-font-size: inherit;
- --doc-font-size--desktop: calc(17 / var(--rem-base) * 1rem);
- --doc-line-height: 1.6;
- --doc-margin: 0 auto;
- --doc-margin--desktop: 0 2rem;
- --heading-font-color: var(--color-jet-80);
- --heading-font-weight: normal;
- --alt-heading-font-weight: var(--body-font-weight-bold);
- --section-divider-color: var(--panel-border-color);
- --link-font-color: #1565c0;
- --link_hover-font-color: #104d92;
- --link_unresolved-font-color: var(--important-color);
- --abstract-background: var(--color-smoke-70);
- --abstract-font-color: var(--color-jet-20);
- --abstract-border-color: var(--panel-border-color);
- --admonition-background: #dafafa;
- --admonition-label-font-weight: var(--body-font-weight-bold);
- --caption-font-color: var(--color-gray-70);
- --caption-font-weight: var(--body-font-weight-bold);
- --code-background: var(--panel-background);
- --code-font-color: var(--body-font-color);
- --example-background: var(--color-white);
- --example-border-color: var(--color-gray-70);
- --kbd-background: var(--panel-background);
- --kbd-border-color: var(--color-gray-10);
- --pre-background: var(--panel-background);
- --pre-border-color: var(--panel-border-color);
- --pre-annotation-font-color: var(--color-gray-10);
- --quote-background: var(--panel-background);
- --quote-border-color: var(--color-gray-70);
- --quote-font-color: var(--color-gray-70);
- --quote-attribution-font-color: var(--color-gray-30);
- --sidebar-background: var(--color-smoke-90);
- --table-border-color: var(--panel-border-color);
- /* footer */
- --footer-line-height: var(--doc-line-height);
- --footer-background: var(--color-smoke-90);
- --footer-font-color: var(--color-gray-70);
- --footer-link-font-color: var(--color-jet-80);
- /* dimensions */
- --navbar-height: calc(63 / var(--rem-base) * 1rem);
- --toolbar-height: calc(45 / var(--rem-base) * 1rem);
- --drawer-height: var(--toolbar-height);
- --body-top: var(--navbar-height);
- --body-min-height: calc(100vh - var(--body-top));
- --nav-height: calc(var(--body-min-height) - var(--toolbar-height));
- --nav-height--desktop: var(--body-min-height);
- --nav-panel-height: calc(var(--nav-height) - var(--drawer-height));
- --nav-panel-height--desktop: calc(var(--nav-height--desktop) - var(--drawer-height));
- --nav-width: calc(270 / var(--rem-base) * 1rem);
- --doc-max-width: calc(720 / var(--rem-base) * 1rem);
- --doc-max-width--desktop: calc(828 / var(--rem-base) * 1rem);
- /* stacking */
- --z-index-nav: 1;
- --z-index-toolbar: 2;
- --z-index-page-version-menu: 3;
- --z-index-navbar: 4;
-}
+++ /dev/null
-'use strict'
-
-module.exports = (a, b) => a && b
+++ /dev/null
-'use strict'
-
-const TAG_ALL_RX = /<[^>]+>/g
-module.exports = (html) => html && html.replace(TAG_ALL_RX, '')
+++ /dev/null
-'use strict'
-
-module.exports = (a, b) => a === b
+++ /dev/null
-'use strict'
-
-module.exports = (value) => (value || 0) + 1
+++ /dev/null
-'use strict'
-
-module.exports = (val) => !val
+++ /dev/null
-'use strict'
-
-module.exports = (a, b) => a || b
+++ /dev/null
-'use strict'
-
-const { posix: path } = require('path')
-
-// TODO memoize me
-function relativize (to, ctx) {
- let from
- // legacy invocation
- if (arguments.length > 2) {
- [from, to, ctx] = arguments
- } else {
- from = ctx.data.root.page.url
- }
- if (!to) return '#'
- const hashIdx = to.indexOf('#')
- if (!hashIdx) return to
- if (!from) return (ctx.data.root.site.path || '') + to
- let hash = ''
- if (~hashIdx) {
- hash = to.substr(hashIdx)
- to = to.substr(0, hashIdx)
- }
- if (from === to) {
- return hash || (isDir(to) ? './' : path.basename(to))
- } else {
- return path.relative(path.dirname(from + '.'), to) + (isDir(to) ? '/' + hash : hash)
- }
-}
-
-function isDir (str) {
- return str.charAt(str.length - 1) === '/'
-}
-
-module.exports = relativize
+++ /dev/null
-'use strict'
-
-module.exports = () => new Date().getFullYear().toString()
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
-
-<svg
- xmlns:dc="http://purl.org/dc/elements/1.1/"
- xmlns:cc="http://creativecommons.org/ns#"
- xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns="http://www.w3.org/2000/svg"
- xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
- xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
- width="100"
- height="100"
- viewBox="0 0 100 100"
- version="1.1"
- inkscape:version="0.92.2 (5c3e80d, 2017-08-06)"
- sodipodi:docname="back.svg"
- enable-background="new">
-<title>Left arrow</title>
-<sodipodi:namedview
- pagecolor="#ffffff"
- bordercolor="#666666"
- borderopacity="1.0"
- inkscape:pageopacity="0.0"
- inkscape:pageshadow="2"
- inkscape:zoom="6.108138"
- inkscape:cx="21.142679"
- inkscape:cy="42.629076"
- inkscape:document-units="px"
- inkscape:current-layer="layer1"
- showgrid="false"
- units="px"
- fit-margin-top="0"
- fit-margin-left="0"
- fit-margin-right="0"
- fit-margin-bottom="0"
- inkscape:window-width="1920"
- inkscape:window-height="1001"
- inkscape:window-x="0"
- inkscape:window-y="41"
- inkscape:window-maximized="1"
- scale-x="1" />
-<metadata>
-<rdf:RDF>
-<cc:Work
- rdf:about="">
-<dc:format>image/svg+xml</dc:format>
-<dc:type
- rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-<dc:title>Left arrow</dc:title>
-<dc:creator>
-<cc:Agent>
-<dc:title>Sarah White</dc:title>
-</cc:Agent>
-</dc:creator>
-<dc:publisher>
-<cc:Agent>
-<dc:title>OpenDevise Inc.</dc:title>
-</cc:Agent>
-</dc:publisher>
-<cc:license
- rdf:resource="http://creativecommons.org/licenses/by-sa/4.0/" />
-</cc:Work>
-<cc:License
- rdf:about="http://creativecommons.org/licenses/by-sa/4.0/">
-<cc:permits
- rdf:resource="http://creativecommons.org/ns#Reproduction" />
-<cc:permits
- rdf:resource="http://creativecommons.org/ns#Distribution" />
-<cc:requires
- rdf:resource="http://creativecommons.org/ns#Notice" />
-<cc:requires
- rdf:resource="http://creativecommons.org/ns#Attribution" />
-<cc:permits
- rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
-<cc:requires
- rdf:resource="http://creativecommons.org/ns#ShareAlike" />
-</cc:License>
-</rdf:RDF>
-</metadata>
-<g
- transform="translate(-3.926492e-7,-270.54187)">
-<path
- d="m 50.000978,280.44162 -40.1010516,40.10025 40.1010516,40.10025 5.6556,-5.65551 -30.434757,-30.44194 h 64.878253 v -8.0056 H 25.221821 l 30.434757,-30.44001 z" />
-</g>
-</svg>
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
-
-<svg
- xmlns:dc="http://purl.org/dc/elements/1.1/"
- xmlns:cc="http://creativecommons.org/ns#"
- xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns="http://www.w3.org/2000/svg"
- xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
- xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
- width="30"
- height="30"
- viewBox="0 0 30 30"
- id="svg2"
- version="1.1"
- inkscape:version="0.91 r13725"
- sodipodi:docname="caret.svg">
- <defs
- id="defs4" />
- <sodipodi:namedview
- id="base"
- borderopacity="1.0"
- inkscape:pageopacity="0.0"
- inkscape:pageshadow="2"
- inkscape:zoom="16"
- inkscape:cx="31.65919"
- inkscape:cy="23.730414"
- inkscape:document-units="px"
- inkscape:current-layer="layer1"
- showgrid="false"
- units="px"
- inkscape:window-width="2688"
- inkscape:window-height="1478"
- inkscape:window-x="0"
- inkscape:window-y="0"
- inkscape:window-maximized="1" />
- <metadata
- id="metadata7">
- <rdf:RDF>
- <cc:Work
- rdf:about="">
- <dc:format>image/svg+xml</dc:format>
- <dc:type
- rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
- <dc:title></dc:title>
- </cc:Work>
- </rdf:RDF>
- </metadata>
- <g
- inkscape:label="Calque 1"
- inkscape:groupmode="layer"
- id="layer1"
- transform="translate(0,-1022.3622)">
- <path
- style="opacity:1;fill:#c1c1c1;fill-opacity:1;stroke:#c1c1c1;stroke-width:1.99999976;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
- d="m 10.18745,1025.362 14.0001,12.0002 -14.0001,12.0001 z"
- id="rect3338"
- inkscape:connector-curvature="0"
- sodipodi:nodetypes="cccc"
- inkscape:transform-center-x="-2.1875" />
- </g>
-</svg>
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
-
-<svg
- xmlns:dc="http://purl.org/dc/elements/1.1/"
- xmlns:cc="http://creativecommons.org/ns#"
- xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns="http://www.w3.org/2000/svg"
- xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
- xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
- width="30"
- height="30"
- viewBox="0 0 30 30"
- id="svg2"
- version="1.1"
- inkscape:version="0.91 r13725"
- sodipodi:docname="chevron.svg">
- <defs
- id="defs4" />
- <sodipodi:namedview
- id="base"
- borderopacity="1.0"
- inkscape:pageopacity="0.0"
- inkscape:pageshadow="2"
- inkscape:zoom="22.627417"
- inkscape:cx="10.05311"
- inkscape:cy="10.530062"
- inkscape:document-units="px"
- inkscape:current-layer="layer1"
- showgrid="false"
- units="px"
- inkscape:window-width="2560"
- inkscape:window-height="1406"
- inkscape:window-x="0"
- inkscape:window-y="0"
- inkscape:window-maximized="1" />
- <metadata
- id="metadata7">
- <rdf:RDF>
- <cc:Work
- rdf:about="">
- <dc:format>image/svg+xml</dc:format>
- <dc:type
- rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
- <dc:title></dc:title>
- </cc:Work>
- </rdf:RDF>
- </metadata>
- <g
- inkscape:label="Calque 1"
- inkscape:groupmode="layer"
- id="layer1"
- transform="translate(0,-1022.3622)">
- <path
- style="opacity:1;fill:#5d5d5d;fill-opacity:1;stroke:none;stroke-width:2;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
- d="M 3.6699219,6.5898438 1.4550781,8.6152344 15,23.374272 28.544922,8.6152344 26.330078,6.5898438 15,18.759498 Z"
- transform="translate(0,1022.3622)"
- id="rect4136"
- inkscape:connector-curvature="0"
- sodipodi:nodetypes="ccccccc" />
- </g>
-</svg>
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
- xmlns:dc="http://purl.org/dc/elements/1.1/"
- xmlns:cc="http://creativecommons.org/ns#"
- xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns="http://www.w3.org/2000/svg"
- xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
- xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
- version="1.1"
- x="0px"
- y="0px"
- viewBox="0 0 100 100"
- id="svg2"
- inkscape:version="0.91 r13725"
- sodipodi:docname="close.svg">
- <metadata
- id="metadata12">
- <rdf:RDF>
- <cc:Work
- rdf:about="">
- <dc:format>image/svg+xml</dc:format>
- <dc:type
- rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
- <dc:title></dc:title>
- </cc:Work>
- </rdf:RDF>
- </metadata>
- <defs
- id="defs10">
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4225"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4221"
- is_visible="true" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4213"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4209"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4204"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4191"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4187"
- is_visible="true" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4183"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4179"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4173"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4169"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4165"
- is_visible="true" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4225-5"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4221-3"
- effect="spiro" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4213-5"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4209-6"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4204-2"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4191-9"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4187-1"
- effect="spiro" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4183-2"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4179-7"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4173-0"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4169-9"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4165-3"
- effect="spiro" />
- </defs>
- <sodipodi:namedview
- borderopacity="1"
- objecttolerance="10"
- gridtolerance="10"
- guidetolerance="10"
- inkscape:pageopacity="0"
- inkscape:pageshadow="2"
- inkscape:window-width="2560"
- inkscape:window-height="1406"
- id="namedview8"
- showgrid="false"
- inkscape:zoom="5.76"
- inkscape:cx="23.393866"
- inkscape:cy="24.955423"
- inkscape:window-x="0"
- inkscape:window-y="0"
- inkscape:window-maximized="1"
- inkscape:current-layer="g4238" />
- <g
- transform="translate(0,-952.36218)"
- id="g4">
- <g
- id="g4238"
- transform="translate(-1.5e-6,-0.2053541)">
- <path
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:8;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
- d="M 12.735931,1039.8317 87.264078,965.30358"
- id="path4180"
- inkscape:connector-curvature="0"
- sodipodi:nodetypes="cc" />
- <path
- sodipodi:nodetypes="cc"
- inkscape:connector-curvature="0"
- id="path4210"
- d="m 12.735931,965.30361 74.528147,74.52809"
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:8;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
- </g>
- </g>
-</svg>
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
- xmlns:dc="http://purl.org/dc/elements/1.1/"
- xmlns:cc="http://creativecommons.org/ns#"
- xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns="http://www.w3.org/2000/svg"
- xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
- xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
- version="1.1"
- x="0px"
- y="0px"
- viewBox="0 0 100 100"
- id="svg2"
- inkscape:version="0.91 r13725"
- sodipodi:docname="home.svg">
- <metadata
- id="metadata12">
- <rdf:RDF>
- <cc:Work
- rdf:about="">
- <dc:format>image/svg+xml</dc:format>
- <dc:type
- rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
- <dc:title></dc:title>
- </cc:Work>
- </rdf:RDF>
- </metadata>
- <defs
- id="defs10">
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4225"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4221"
- is_visible="true" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4213"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4209"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4204"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4191"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4187"
- is_visible="true" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4183"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4179"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4173"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4169"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4165"
- is_visible="true" />
- </defs>
- <sodipodi:namedview
- borderopacity="1"
- objecttolerance="10"
- gridtolerance="10"
- guidetolerance="10"
- inkscape:pageopacity="0"
- inkscape:pageshadow="2"
- inkscape:window-width="2560"
- inkscape:window-height="1406"
- id="namedview8"
- showgrid="false"
- inkscape:zoom="8.1458701"
- inkscape:cx="33.343764"
- inkscape:cy="44.907032"
- inkscape:window-x="0"
- inkscape:window-y="0"
- inkscape:window-maximized="1"
- inkscape:current-layer="g4" />
- <g
- transform="translate(0,-952.36218)"
- id="g4">
- <path
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;fill-opacity:1"
- d="M 50.019531 13.576172 L 21.439453 39.115234 L 21.419922 86.460938 L 42.925781 86.460938 L 42.951172 61.294922 L 57.048828 61.294922 L 57.074219 86.460938 L 78.619141 86.460938 L 78.638672 39.150391 L 50.019531 13.576172 z "
- id="path4175"
- transform="translate(0,952.36218)" />
- <path
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
- d="m 63.815035,25.903568 0,-9.217018 8.656932,0 -2e-6,16.95383 z"
- id="path4193"
- transform="translate(0,952.36218)"
- inkscape:connector-curvature="0"
- sodipodi:nodetypes="ccccc" />
- <path
- inkscape:connector-curvature="0"
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
- d="m 21.43888,991.47783 -9.98234,8.92037"
- id="path4177" />
- <path
- inkscape:connector-curvature="0"
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
- d="m 88.58189,1000.3982 -9.94315,-8.88535"
- id="path4170" />
- </g>
-</svg>
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
- xmlns:dc="http://purl.org/dc/elements/1.1/"
- xmlns:cc="http://creativecommons.org/ns#"
- xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns="http://www.w3.org/2000/svg"
- xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
- xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
- version="1.1"
- x="0px"
- y="0px"
- viewBox="0 0 100 100"
- id="svg2"
- inkscape:version="0.91 r13725"
- sodipodi:docname="home-hovered.svg">
- <metadata
- id="metadata12">
- <rdf:RDF>
- <cc:Work
- rdf:about="">
- <dc:format>image/svg+xml</dc:format>
- <dc:type
- rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
- <dc:title></dc:title>
- </cc:Work>
- </rdf:RDF>
- </metadata>
- <defs
- id="defs10">
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4225"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4221"
- is_visible="true" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4213"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4209"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4204"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4191"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4187"
- is_visible="true" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4183"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4179"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4173"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4169"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4165"
- is_visible="true" />
- </defs>
- <sodipodi:namedview
- borderopacity="1"
- objecttolerance="10"
- gridtolerance="10"
- guidetolerance="10"
- inkscape:pageopacity="0"
- inkscape:pageshadow="2"
- inkscape:window-width="2560"
- inkscape:window-height="1406"
- id="namedview8"
- showgrid="false"
- inkscape:zoom="8.1458701"
- inkscape:cx="-15.147065"
- inkscape:cy="42.942846"
- inkscape:window-x="0"
- inkscape:window-y="0"
- inkscape:window-maximized="1"
- inkscape:current-layer="g4" />
- <g
- transform="translate(0,-952.36218)"
- id="g4">
- <path
- style="fill:#222;fill-rule:evenodd;stroke:#222;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;fill-opacity:1"
- d="M 50.019531 13.576172 L 21.439453 39.115234 L 21.419922 86.460938 L 42.925781 86.460938 L 42.951172 61.294922 L 57.048828 61.294922 L 57.074219 86.460938 L 78.619141 86.460938 L 78.638672 39.150391 L 50.019531 13.576172 z "
- id="path4175"
- transform="translate(0,952.36218)" />
- <path
- style="fill:#222;fill-rule:evenodd;stroke:#222;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;fill-opacity:1"
- d="m 63.815035,25.903568 0,-9.217018 8.656932,0 -2e-6,16.95383 z"
- id="path4193"
- transform="translate(0,952.36218)"
- inkscape:connector-curvature="0"
- sodipodi:nodetypes="ccccc" />
- <path
- inkscape:connector-curvature="0"
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
- d="m 21.43888,991.47783 -9.98234,8.92037"
- id="path4177" />
- <path
- inkscape:connector-curvature="0"
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
- d="m 88.58189,1000.3982 -9.94315,-8.88535"
- id="path4170" />
- </g>
-</svg>
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
- xmlns:dc="http://purl.org/dc/elements/1.1/"
- xmlns:cc="http://creativecommons.org/ns#"
- xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns="http://www.w3.org/2000/svg"
- xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
- xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
- version="1.1"
- x="0px"
- y="0px"
- viewBox="0 0 100 100"
- id="svg2"
- inkscape:version="0.91 r13725"
- sodipodi:docname="menu.svg">
- <metadata
- id="metadata12">
- <rdf:RDF>
- <cc:Work
- rdf:about="">
- <dc:format>image/svg+xml</dc:format>
- <dc:type
- rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
- <dc:title></dc:title>
- </cc:Work>
- </rdf:RDF>
- </metadata>
- <defs
- id="defs10">
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4225"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4221"
- is_visible="true" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4213"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4209"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4204"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4191"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4187"
- is_visible="true" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4183"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4179"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4173"
- is_visible="true" />
- <inkscape:path-effect
- is_visible="true"
- id="path-effect4169"
- effect="spiro" />
- <inkscape:path-effect
- effect="spiro"
- id="path-effect4165"
- is_visible="true" />
- </defs>
- <sodipodi:namedview
- borderopacity="1"
- objecttolerance="10"
- gridtolerance="10"
- guidetolerance="10"
- inkscape:pageopacity="0"
- inkscape:pageshadow="2"
- inkscape:window-width="2560"
- inkscape:window-height="1406"
- id="namedview8"
- showgrid="false"
- inkscape:zoom="5.76"
- inkscape:cx="14.532031"
- inkscape:cy="43.425849"
- inkscape:window-x="0"
- inkscape:window-y="1440"
- inkscape:window-maximized="1"
- inkscape:current-layer="g4" />
- <g
- transform="translate(0,-952.36218)"
- id="g4">
- <g
- id="g4238"
- transform="translate(-1.5e-6,-0.2053541)">
- <path
- sodipodi:nodetypes="cc"
- inkscape:connector-curvature="0"
- id="path4149"
- d="m 35,972.34003 55.000003,0"
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:8;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.94117647" />
- <rect
- y="964.84003"
- x="10"
- height="15"
- width="15"
- id="rect4184"
- style="opacity:1;fill:#222;fill-opacity:1;stroke:none;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
- <path
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.94117647"
- d="m 42.999999,1016.2452 44.999999,0"
- id="path4180"
- inkscape:connector-curvature="0"
- sodipodi:nodetypes="cc" />
- <rect
- style="opacity:1;fill:#222;fill-opacity:1;stroke:none;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
- id="rect4186"
- width="10"
- height="10"
- x="23"
- y="1011.2452" />
- <path
- sodipodi:nodetypes="cc"
- inkscape:connector-curvature="0"
- id="path4182"
- d="m 42.999999,1035.295 44.999999,0"
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.94117647" />
- <rect
- y="1030.295"
- x="23"
- height="10"
- width="10"
- id="rect4188"
- style="opacity:1;fill:#222;fill-opacity:1;stroke:none;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
- <path
- sodipodi:nodetypes="cc"
- inkscape:connector-curvature="0"
- id="path4210"
- d="m 42.999999,997.1955 44.999999,0"
- style="fill:none;fill-rule:evenodd;stroke:#222;stroke-width:5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.94117647" />
- <rect
- y="992.1955"
- x="23"
- height="10"
- width="10"
- id="rect4212"
- style="opacity:1;fill:#222;fill-opacity:1;stroke:none;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
- </g>
- </g>
-</svg>
+++ /dev/null
-;(function () {
- 'use strict'
-
- var navContainer = document.querySelector('.nav-container')
- var navToggle = document.querySelector('.nav-toggle')
-
- navToggle.addEventListener('click', showNav)
- // NOTE don't let click events propagate outside of nav container
- navContainer.addEventListener('click', concealEvent)
-
- var menuPanel = navContainer.querySelector('[data-panel=menu]')
- if (!menuPanel) return
- var nav = navContainer.querySelector('.nav')
-
- var currentPageItem = menuPanel.querySelector('.is-current-page')
- if (currentPageItem) {
- activateCurrentPath(currentPageItem)
- scrollItemToMidpoint(menuPanel, currentPageItem.querySelector('.nav-link'))
- } else {
- menuPanel.scrollTop = 0
- }
-
- find(menuPanel, '.nav-item-toggle').forEach(function (btn) {
- var li = btn.parentElement
- btn.addEventListener('click', toggleActive.bind(li))
- var navItemSpan = findNextElement(btn, '.nav-text')
- if (navItemSpan) {
- navItemSpan.style.cursor = 'pointer'
- navItemSpan.addEventListener('click', toggleActive.bind(li))
- }
- })
-
- nav.querySelector('.context').addEventListener('click', function () {
- var currentPanel = nav.querySelector('.is-active[data-panel]')
- var activatePanel = currentPanel.dataset.panel === 'menu' ? 'explore' : 'menu'
- currentPanel.classList.toggle('is-active')
- nav.querySelector('[data-panel=' + activatePanel + ']').classList.toggle('is-active')
- })
-
- // NOTE prevent text from being selected by double click
- menuPanel.addEventListener('mousedown', function (e) {
- if (e.detail > 1) e.preventDefault()
- })
-
- function activateCurrentPath (navItem) {
- var ancestorClasses
- var ancestor = navItem.parentNode
- while (!(ancestorClasses = ancestor.classList).contains('nav-menu')) {
- if (ancestor.tagName === 'LI' && ancestorClasses.contains('nav-item')) {
- ancestorClasses.add('is-active', 'is-current-path')
- }
- ancestor = ancestor.parentNode
- }
- navItem.classList.add('is-active')
- }
-
- function toggleActive () {
- this.classList.toggle('is-active')
- }
-
- function showNav (e) {
- if (navToggle.classList.contains('is-active')) return hideNav(e)
- var html = document.documentElement
- html.classList.add('is-clipped--nav')
- navToggle.classList.add('is-active')
- navContainer.classList.add('is-active')
- html.addEventListener('click', hideNav)
- concealEvent(e)
- }
-
- function hideNav (e) {
- var html = document.documentElement
- html.classList.remove('is-clipped--nav')
- navToggle.classList.remove('is-active')
- navContainer.classList.remove('is-active')
- html.removeEventListener('click', hideNav)
- concealEvent(e)
- }
-
- // NOTE don't let event get picked up by window click listener
- function concealEvent (e) {
- e.stopPropagation()
- }
-
- function scrollItemToMidpoint (panel, el) {
- var rect = panel.getBoundingClientRect()
- var effectiveHeight = rect.height
- var navStyle = window.getComputedStyle(nav)
- if (navStyle.position === 'sticky') effectiveHeight -= rect.top - parseFloat(navStyle.top)
- panel.scrollTop = Math.max(0, (el.getBoundingClientRect().height - effectiveHeight) * 0.5 + el.offsetTop)
- }
-
- function find (from, selector) {
- return [].slice.call(from.querySelectorAll(selector))
- }
-
- function findNextElement (from, selector) {
- var el
- if ('nextElementSibling' in from) {
- el = from.nextElementSibling
- } else {
- el = from
- while ((el = el.nextSibling) && el.nodeType !== 1);
- }
- return el && selector ? el[el.matches ? 'matches' : 'msMatchesSelector'](selector) && el : el
- }
-})()
+++ /dev/null
-;(function () {
- 'use strict'
-
- var article = document.querySelector('article.doc')
- var toolbar = document.querySelector('.toolbar')
-
- function computePosition (el, sum) {
- if (article.contains(el)) {
- return computePosition(el.offsetParent, el.offsetTop + sum)
- } else {
- return sum
- }
- }
-
- function jumpToAnchor (e) {
- if (e) {
- window.location.hash = '#' + this.id
- e.preventDefault()
- }
- window.scrollTo(0, computePosition(this, 0) - toolbar.getBoundingClientRect().bottom)
- }
-
- window.addEventListener('load', function jumpOnLoad (e) {
- var hash, target
- if ((hash = window.location.hash) && (target = document.getElementById(hash.slice(1)))) {
- jumpToAnchor.bind(target)()
- setTimeout(jumpToAnchor.bind(target), 0)
- }
- window.removeEventListener('load', jumpOnLoad)
- })
-
- Array.prototype.slice.call(document.querySelectorAll('a[href^="#"]')).forEach(function (el) {
- var hash, target
- if ((hash = el.hash.slice(1)) && (target = document.getElementById(hash))) {
- el.addEventListener('click', jumpToAnchor.bind(target))
- }
- })
-})()
+++ /dev/null
-;(function () {
- 'use strict'
-
- var toggle = document.querySelector('.page-versions .version-menu-toggle')
- if (!toggle) return
-
- var selector = document.querySelector('.page-versions')
-
- toggle.addEventListener('click', function (e) {
- selector.classList.toggle('is-active')
- // don't let this event get smothered
- e.stopPropagation()
- })
-
- document.documentElement.addEventListener('click', function () {
- selector.classList.remove('is-active')
- })
-})()
+++ /dev/null
-document.addEventListener('DOMContentLoaded', function () {
- var navbarToggles = Array.prototype.slice.call(document.querySelectorAll('.navbar-burger'), 0)
- if (navbarToggles.length === 0) return
- navbarToggles.forEach(function (el) {
- el.addEventListener('click', function (e) {
- e.stopPropagation()
- el.classList.toggle('is-active')
- document.getElementById(el.dataset.target).classList.toggle('is-active')
- document.documentElement.classList.toggle('is-clipped--navbar')
- })
- })
-})
+++ /dev/null
-;(function () {
- 'use strict'
-
- var hljs = require('highlight.js/lib/highlight')
- hljs.registerLanguage('apache', require('highlight.js/lib/languages/apache'))
- hljs.registerLanguage('asciidoc', require('highlight.js/lib/languages/asciidoc'))
- hljs.registerLanguage('bash', require('highlight.js/lib/languages/bash'))
- hljs.registerLanguage('clojure', require('highlight.js/lib/languages/clojure'))
- hljs.registerLanguage('cpp', require('highlight.js/lib/languages/cpp'))
- hljs.registerLanguage('cs', require('highlight.js/lib/languages/cs'))
- hljs.registerLanguage('css', require('highlight.js/lib/languages/css'))
- hljs.registerLanguage('diff', require('highlight.js/lib/languages/diff'))
- hljs.registerLanguage('dockerfile', require('highlight.js/lib/languages/dockerfile'))
- hljs.registerLanguage('go', require('highlight.js/lib/languages/go'))
- hljs.registerLanguage('groovy', require('highlight.js/lib/languages/groovy'))
- hljs.registerLanguage('haskell', require('highlight.js/lib/languages/haskell'))
- hljs.registerLanguage('http', require('highlight.js/lib/languages/http'))
- hljs.registerLanguage('ini', require('highlight.js/lib/languages/ini'))
- hljs.registerLanguage('java', require('highlight.js/lib/languages/java'))
- hljs.registerLanguage('javascript', require('highlight.js/lib/languages/javascript'))
- hljs.registerLanguage('json', require('highlight.js/lib/languages/json'))
- hljs.registerLanguage('kotlin', require('highlight.js/lib/languages/kotlin'))
- hljs.registerLanguage('makefile', require('highlight.js/lib/languages/makefile'))
- hljs.registerLanguage('markdown', require('highlight.js/lib/languages/markdown'))
- hljs.registerLanguage('nginx', require('highlight.js/lib/languages/nginx'))
- hljs.registerLanguage('nix', require('highlight.js/lib/languages/nix'))
- hljs.registerLanguage('objectivec', require('highlight.js/lib/languages/objectivec'))
- hljs.registerLanguage('perl', require('highlight.js/lib/languages/perl'))
- hljs.registerLanguage('php', require('highlight.js/lib/languages/php'))
- hljs.registerLanguage('properties', require('highlight.js/lib/languages/properties'))
- hljs.registerLanguage('python', require('highlight.js/lib/languages/python'))
- hljs.registerLanguage('ruby', require('highlight.js/lib/languages/ruby'))
- hljs.registerLanguage('scala', require('highlight.js/lib/languages/scala'))
- hljs.registerLanguage('shell', require('highlight.js/lib/languages/shell'))
- hljs.registerLanguage('sql', require('highlight.js/lib/languages/sql'))
- hljs.registerLanguage('swift', require('highlight.js/lib/languages/swift'))
- hljs.registerLanguage('xml', require('highlight.js/lib/languages/xml'))
- hljs.registerLanguage('yaml', require('highlight.js/lib/languages/yaml'))
- hljs.initHighlighting()
-})()
+++ /dev/null
-<!DOCTYPE html>
-<html lang="en">
- <head>
-{{> head defaultPageTitle='Page Not Found'}}
- </head>
- <body class="status-404">
-{{> header}}
-{{> body}}
-{{> footer}}
- </body>
-</html>
+++ /dev/null
-<!DOCTYPE html>
-<html lang="en">
- <head>
-{{> head defaultPageTitle='Untitled'}}
- </head>
- <body class="article">
-{{> header}}
-{{> body}}
-{{> footer}}
- </body>
-</html>
+++ /dev/null
-<article class="doc">
-{{#if (eq page.layout '404')}}
-<h1 class="page">{{{or page.title 'Page Not Found'}}}</h1>
-<div class="paragraph">
-<p>The page you’re looking for does not exist. It may have been moved.</p>
-</div>
-<div class="paragraph">
-<p>If you arrived on this page by clicking on a link, please notify the owner of the site that the link is broken.
-If you typed the URL of this page manually, please double check that you entered the address correctly.</p>
-</div>
-{{else}}
-{{#if page.title}}
-<h1 class="page">{{{page.title}}}</h1>
-{{/if}}
-{{{page.contents}}}
-<div class="article-footer">
- <div class="article-footer-previous">
- <a href="{{site.path}}{{page.previous.url}}">Previous</a>
- </div>
- <div class="article-footer-next">
- <a href="{{site.path}}{{page.next.url}}">Next</a>
- </div>
-</div>
-{{/if}}
-</article>
+++ /dev/null
-<div class="body">
-{{> nav}}
-{{> main}}
-</div>
+++ /dev/null
-<nav class="breadcrumbs" aria-label="breadcrumbs">
- {{#if page.breadcrumbs}}
- <ul>
- {{#with page.componentVersion}}
- {{#if (and ./title (not (or ./root (eq @root.page.breadcrumbs.0.content ./title))))}}
- <li><a href="{{{relativize ./url}}}">{{{./title}}}</a></li>
- {{/if}}
- {{/with}}
- {{#each page.breadcrumbs}}
- <li>
- {{~#if (and ./url (eq ./urlType 'internal'))~}}
- <a href="{{{relativize ./url}}}">{{{./content}}}</a>
- {{~else~}}
- {{{./content}}}
- {{~/if~}}
- </li>
- {{/each}}
- </ul>
- {{/if}}
-</nav>
+++ /dev/null
-<footer class="footer">
- <p>This page was built using the Antora default UI.</p>
- <p>The source code for this UI is licensed under the terms of the MPL-2.0 license.</p>
-</footer>
+++ /dev/null
-<script src="{{uiRootPath}}/js/site.js"></script>
-<script async src="{{uiRootPath}}/js/vendor/highlight.js"></script>
+++ /dev/null
-{{> footer-content}}
-{{> footer-scripts}}
+++ /dev/null
- {{!-- <link rel="icon" href="{{uiRootPath}}/img/favicon.ico" type="image/x-icon"> --}}
+++ /dev/null
- {{#if page.canonicalUrl}}
- <link rel="canonical" href="{{page.canonicalUrl}}">
- {{/if}}
- {{#if page.component}}
- {{#if page.description}}
- <meta name="description" content="{{page.description}}">
- {{/if}}
- {{#if page.keywords}}
- <meta name="keywords" content="{{page.keywords}}">
- {{/if}}
- {{/if}}
- {{#if (or antoraVersion site.antoraVersion)}}
- <meta name="generator" content="Antora {{or antoraVersion site.antoraVersion}}">
- {{/if}}
+++ /dev/null
- {{!-- Add additional meta tags here --}}
+++ /dev/null
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width,initial-scale=1">
+++ /dev/null
- {{#if site.keys.googleAnalytics}}
- <script async src="https://www.googletagmanager.com/gtag/js?id={{site.keys.googleAnalytics}}"></script>
- <script>function gtag(){dataLayer.push(arguments)};window.dataLayer=window.dataLayer||[];gtag('js',new Date());gtag('config','{{site.keys.googleAnalytics}}')</script>
- {{/if}}
+++ /dev/null
- <link rel="stylesheet" href="{{uiRootPath}}/css/site.css">
+++ /dev/null
- <title>{{{detag (or page.title defaultPageTitle)}}}{{#if site.title}} :: {{site.title}}{{/if}}</title>
+++ /dev/null
-{{> head-prelude}}
-{{> head-title}}
-{{> head-info}}
-{{> head-styles}}
-{{> head-meta}}
-{{> head-scripts}}
-{{> head-icons}}
+++ /dev/null
-<header class="header" role="banner">
- <nav class="navbar">
- <div class="navbar-brand">
- <a class="navbar-item" href="{{or site.url (or siteRootUrl siteRootPath)}}">{{site.title}}</a>
- <button class="navbar-burger" data-target="topbar-nav">
- <span></span>
- <span></span>
- <span></span>
- </button>
- </div>
- <div id="topbar-nav" class="navbar-menu">
- <div class="navbar-end">
- <div class="navbar-item has-dropdown is-hoverable">
- <a class="navbar-link" href="#">Documentation</a>
- <div class="navbar-dropdown">
- <a class="navbar-item" href="http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:dig">Documentation Interest Group</a>
- <a class="navbar-item" href="http://evergreen-ils.org/dokuwiki/doku.php?id=faqs:evergreen_roadmap">Evergreen Roadmap</a>
- <a class="navbar-item" href="http://wiki.evergreen-ils.org/">Evergreen Wiki</a>
- <a class="navbar-item" href="https://evergreen-ils.org/eg-documentation/tabular-release-notes/">Tabular Release Notes</a>
- </div>
- </div>
- <div class="navbar-item has-dropdown is-hoverable">
- <a class="navbar-link" href="#">Downloads</a>
- <div class="navbar-dropdown">
- <a class="navbar-item" href="https://evergreen-ils.org/trademark-policy/">Evergreen Downloads</a>
- <a class="navbar-item" href="https://evergreen-ils.org/opensrf-downloads/">OpenSRF Downloads</a>
- </div>
- </div>
- <div class="navbar-item has-dropdown is-hoverable">
- <a class="navbar-link" href="#">About Us</a>
- <div class="navbar-dropdown">
- <a class="navbar-item" href="https://evergreen-ils.org/about-us/">Overview</a>
- <a class="navbar-item" href="https://evergreen-ils.org/about-us/annual-reports/">Annual Reports</a>
- <a class="navbar-item" href="https://evergreen-ils.org/frequently-anticipated-questions/">F.A.Q.</a>
- <a class="navbar-item" href="https://evergreen-ils.org/code-of-conduct/">Evergreen Event Code of Conduct</a>
- <a class="navbar-item" href="https://evergreen-ils.org/governance/">Project Governance</a>
- <a class="navbar-item" href="https://evergreen-ils.org/trademark-policy/">Trademark Policy</a>
- </div>
- </div>
- </div>
- </div>
- {{#if env.DOCSEARCH_ENABLED}}
- <div class="navbar-item">
- <input id="search-input" type="text" placeholder="Search docs">
- </div>
- {{/if}}
- </nav>
-</header>
+++ /dev/null
-{{!-- Add header scripts here --}}
+++ /dev/null
-{{> header-scripts}}
-{{> header-content}}
+++ /dev/null
-<main>
-{{> toolbar}}
-{{> article}}
-</main>
+++ /dev/null
-<div class="nav-panel-explore{{#unless page.navigation}} is-active{{/unless}}" data-panel="explore">
- {{#if page.component}}
- <div class="context">
- <span class="title">{{page.component.title}}</span>
- <span class="version">{{page.componentVersion.displayVersion}}</span>
- </div>
- {{/if}}
- <ul class="components">
- {{#each site.components}}
- <li class="component{{#if (eq this @root.page.component)}} is-current{{/if}}">
- <span class="title">{{{./title}}}</span>
- <ul class="versions">
- {{#each ./versions}}
- <li class="version
- {{~#if (and (eq ../this @root.page.component) (eq this @root.page.componentVersion))}} is-current{{/if~}}
- {{~#if (eq this ../latestVersion)}} is-latest{{/if}}">
- <a href="{{{relativize ./url}}}">{{./displayVersion}}</a>
- </li>
- {{/each}}
- </ul>
- </li>
- {{/each}}
- </ul>
-</div>
+++ /dev/null
-{{#if page.navigation}}
-<div class="nav-panel-menu is-active" data-panel="menu">
- <nav class="nav-menu">
- <h3 class="title"><a href="{{relativize page.componentVersion.url}}">{{page.component.title}}</a></h3>
-{{> nav-tree navigation=page.navigation}}
- </nav>
-</div>
-{{/if}}
+++ /dev/null
-<button class="nav-toggle"></button>
+++ /dev/null
-{{#if navigation.length}}
-<ul class="nav-list">
- {{#each navigation}}
- <li class="nav-item{{#if (eq @root.page.url ./url)}} is-current-page{{/if}}" data-depth="{{or ../level 0}}">
- {{#if ./content}}
- {{#if ./items.length}}
- <button class="nav-item-toggle"></button>
- {{/if}}
- {{#if ./url}}
- <a class="nav-link" href="
- {{~#if (eq ./urlType 'internal')}}{{{relativize ./url}}}
- {{~else}}{{{./url}}}{{~/if}}">{{{./content}}}</a>
- {{else}}
- <span class="nav-text">{{{./content}}}</span>
- {{/if}}
- {{/if}}
-{{> nav-tree navigation=./items level=(increment ../level)}}
- </li>
- {{/each}}
-</ul>
-{{/if}}
+++ /dev/null
-<div class="nav-container"{{#if page.component}} data-component="{{page.component.name}}" data-version="{{page.version}}"{{/if}}>
- <aside class="nav">
- <div class="panels">
-{{> nav-menu}}
-{{> nav-explore}}
- </div>
- </aside>
-</div>
+++ /dev/null
-{{#if page.versions}}
-<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">{{page.componentVersion.displayVersion}}</button>
- <div class="version-menu">
- {{#each page.versions}}
- <a class="version
- {{~#if (eq ./version @root.page.version)}} is-current{{/if~}}
- {{~#if ./missing}} is-missing{{/if}}" href="{{{relativize ./url}}}">{{./displayVersion}}</a>
- {{/each}}
- </div>
-</div>
-{{/if}}
+++ /dev/null
-<div class="toolbar" role="navigation">
-{{> nav-toggle}}
- {{#if site.homeUrl}}
- <a href="{{relativize site.homeUrl}}" class="home-link{{#if page.home}} is-current{{/if}}"></a>
- {{/if}}
-{{> breadcrumbs}}
-{{> page-versions}}
- {{#if (and page.editUrl (not page.origin.private))}}
- <!--
- Removing the edit link until we have these docs on master/rel branches
- <div class="edit-this-page"><a href="{{page.editUrl}}">Edit this Page</a></div>
- -->
- {{/if}}
-</div>
projects / evergreen-equinox.git / commitdiff
