asciidocsy 0.3.0.pre.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +201 -0
- data/_config.yml +66 -0
- data/_data/theme/alerts.yml +21 -0
- data/_data/theme/blocks.yml +33 -0
- data/_data/theme/forms.yml +72 -0
- data/_data/theme/navigation.yml +53 -0
- data/_data/theme/page-actions.yml +83 -0
- data/_data/theme/policies.yml +68 -0
- data/_data/theme/release-hx.yml +163 -0
- data/_data/theme/scripts.yml +43 -0
- data/_data/theme/semantics.yml +14 -0
- data/_data/theme/strings.yml +13 -0
- data/_data/theme/styles.yml +8 -0
- data/_docs/snippets/example_tabset-source.adoc +60 -0
- data/_docs/snippets/example_tabset-source_data.json +16 -0
- data/_docs/snippets/example_tabset-source_data.xml +17 -0
- data/_docs/snippets/example_tabset-source_data.yml +10 -0
- data/_docs/snippets/example_toggles.adoc +25 -0
- data/_docs/snippets/handlers-table.adoc +40 -0
- data/_docs/snippets/reference-cluster.adoc +1 -0
- data/_docs/topics/advanced-applications_c.adoc +50 -0
- data/_docs/topics/config-api_r.adoc +21 -0
- data/_docs/topics/config-release-hx.adoc +4 -0
- data/_docs/topics/config-search-algolia.adoc +77 -0
- data/_docs/topics/config-search.adoc +47 -0
- data/_docs/topics/config-semantics.adoc +45 -0
- data/_docs/topics/config-switcher_r.adoc +33 -0
- data/_docs/topics/config-tabber_r.adoc +49 -0
- data/_docs/topics/config-toggle_r.adoc +20 -0
- data/_docs/topics/config-versioning-amenders_r.adoc +76 -0
- data/_docs/topics/config-versioning-swaps_r.adoc +193 -0
- data/_docs/topics/config-versioning-tabsets_r.adoc +51 -0
- data/_docs/topics/config-versioning-toggles_r.adoc +42 -0
- data/_docs/topics/config-versioning.adoc +134 -0
- data/_docs/topics/config_r.adoc +131 -0
- data/_docs/topics/extend.adoc +70 -0
- data/_docs/topics/frontend-overview.adoc +62 -0
- data/_docs/topics/intro.adoc +6 -0
- data/_docs/topics/setup-bootstrap_t.adoc +71 -0
- data/_docs/topics/setup-environment_rg.adoc +65 -0
- data/_docs/topics/setup-quickstart_t.adoc +10 -0
- data/_docs/topics/setup.adoc +31 -0
- data/_docs/topics/syntax-highlighter-examples_r.adoc +172 -0
- data/_docs/topics/toolchain.adoc +79 -0
- data/_docs/topics/upgrade-0-3-0.adoc +49 -0
- data/_includes/_settings.liquid +2 -0
- data/_includes/_variables.sass +12 -0
- data/_includes/breadcrumbs.html +20 -0
- data/_includes/breadcrumbs_alt.html +6 -0
- data/_includes/config-api-objects.asciidoc +23 -0
- data/_includes/config-api-properties.asciidoc +29 -0
- data/_includes/config-api.asciidoc +29 -0
- data/_includes/feedback.html +59 -0
- data/_includes/footer-links_sup.html +5 -0
- data/_includes/footer.html +59 -0
- data/_includes/gdpr-message.html +41 -0
- data/_includes/google-analytics.html +11 -0
- data/_includes/head.html +74 -0
- data/_includes/header.html +22 -0
- data/_includes/hook.liquid +26 -0
- data/_includes/nav-site.html +30 -0
- data/_includes/nav-subject-menu.html +49 -0
- data/_includes/page-links.html +45 -0
- data/_includes/path-active.liquid +18 -0
- data/_includes/release-hx-change.asciidoc +7 -0
- data/_includes/release-hx-changes-listing.asciidoc +14 -0
- data/_includes/release-hx-note.asciidoc +54 -0
- data/_includes/release-hx-notes-listing.asciidoc +16 -0
- data/_includes/release-hx-revision.asciidoc +86 -0
- data/_includes/release-hx.asciidoc +57 -0
- data/_includes/scripts.html +8 -0
- data/_includes/search-form.html +113 -0
- data/_includes/see-also.html +17 -0
- data/_includes/social-links.html +10 -0
- data/_includes/string-eval.liquid +38 -0
- data/_includes/tail.html +7 -0
- data/_includes/theme-api-object-sub.asciidoc +4 -0
- data/_includes/theme-api-object.asciidoc +35 -0
- data/_includes/version-handler.html +245 -0
- data/_includes/versioning-controls.html +88 -0
- data/_layouts/default.html +94 -0
- data/_layouts/landing.html +28 -0
- data/_layouts/page.html +9 -0
- data/_layouts/post.html +8 -0
- data/_layouts/reference.html +6 -0
- data/_layouts/search.html +110 -0
- data/_layouts/topic.html +19 -0
- data/_sass/_asciidocsy.scss +698 -0
- data/_sass/_custom.scss +3 -0
- data/_sass/bootstrap/_alert.scss +51 -0
- data/_sass/bootstrap/_badge.scss +54 -0
- data/_sass/bootstrap/_breadcrumb.scss +41 -0
- data/_sass/bootstrap/_button-group.scss +163 -0
- data/_sass/bootstrap/_buttons.scss +137 -0
- data/_sass/bootstrap/_card.scss +289 -0
- data/_sass/bootstrap/_carousel.scss +197 -0
- data/_sass/bootstrap/_close.scss +41 -0
- data/_sass/bootstrap/_code.scss +48 -0
- data/_sass/bootstrap/_custom-forms.scss +507 -0
- data/_sass/bootstrap/_dropdown.scss +191 -0
- data/_sass/bootstrap/_forms.scss +330 -0
- data/_sass/bootstrap/_functions.scss +86 -0
- data/_sass/bootstrap/_grid.scss +52 -0
- data/_sass/bootstrap/_images.scss +42 -0
- data/_sass/bootstrap/_input-group.scss +193 -0
- data/_sass/bootstrap/_jumbotron.scss +17 -0
- data/_sass/bootstrap/_list-group.scss +149 -0
- data/_sass/bootstrap/_media.scss +8 -0
- data/_sass/bootstrap/_mixins.scss +47 -0
- data/_sass/bootstrap/_modal.scss +229 -0
- data/_sass/bootstrap/_nav.scss +120 -0
- data/_sass/bootstrap/_navbar.scss +294 -0
- data/_sass/bootstrap/_pagination.scss +73 -0
- data/_sass/bootstrap/_popover.scss +171 -0
- data/_sass/bootstrap/_print.scss +141 -0
- data/_sass/bootstrap/_progress.scss +43 -0
- data/_sass/bootstrap/_reboot.scss +483 -0
- data/_sass/bootstrap/_root.scss +19 -0
- data/_sass/bootstrap/_spinners.scss +55 -0
- data/_sass/bootstrap/_tables.scss +185 -0
- data/_sass/bootstrap/_toasts.scss +44 -0
- data/_sass/bootstrap/_tooltip.scss +115 -0
- data/_sass/bootstrap/_transitions.scss +20 -0
- data/_sass/bootstrap/_type.scss +125 -0
- data/_sass/bootstrap/_utilities.scss +17 -0
- data/_sass/bootstrap/_variables.scss +1123 -0
- data/_sass/bootstrap/bootstrap-grid.scss +29 -0
- data/_sass/bootstrap/bootstrap-reboot.scss +12 -0
- data/_sass/bootstrap/bootstrap.scss +44 -0
- data/_sass/bootstrap/mixins/_alert.scss +13 -0
- data/_sass/bootstrap/mixins/_background-variant.scss +21 -0
- data/_sass/bootstrap/mixins/_badge.scss +17 -0
- data/_sass/bootstrap/mixins/_border-radius.scss +63 -0
- data/_sass/bootstrap/mixins/_box-shadow.scss +20 -0
- data/_sass/bootstrap/mixins/_breakpoints.scss +123 -0
- data/_sass/bootstrap/mixins/_buttons.scss +107 -0
- data/_sass/bootstrap/mixins/_caret.scss +62 -0
- data/_sass/bootstrap/mixins/_clearfix.scss +7 -0
- data/_sass/bootstrap/mixins/_deprecate.scss +10 -0
- data/_sass/bootstrap/mixins/_float.scss +14 -0
- data/_sass/bootstrap/mixins/_forms.scss +192 -0
- data/_sass/bootstrap/mixins/_gradients.scss +45 -0
- data/_sass/bootstrap/mixins/_grid-framework.scss +66 -0
- data/_sass/bootstrap/mixins/_grid.scss +51 -0
- data/_sass/bootstrap/mixins/_hover.scss +37 -0
- data/_sass/bootstrap/mixins/_image.scss +36 -0
- data/_sass/bootstrap/mixins/_list-group.scss +21 -0
- data/_sass/bootstrap/mixins/_lists.scss +7 -0
- data/_sass/bootstrap/mixins/_nav-divider.scss +10 -0
- data/_sass/bootstrap/mixins/_pagination.scss +22 -0
- data/_sass/bootstrap/mixins/_reset-text.scss +17 -0
- data/_sass/bootstrap/mixins/_resize.scss +6 -0
- data/_sass/bootstrap/mixins/_screen-reader.scss +33 -0
- data/_sass/bootstrap/mixins/_size.scss +7 -0
- data/_sass/bootstrap/mixins/_table-row.scss +39 -0
- data/_sass/bootstrap/mixins/_text-emphasis.scss +16 -0
- data/_sass/bootstrap/mixins/_text-hide.scss +11 -0
- data/_sass/bootstrap/mixins/_text-truncate.scss +8 -0
- data/_sass/bootstrap/mixins/_transition.scss +16 -0
- data/_sass/bootstrap/mixins/_visibility.scss +8 -0
- data/_sass/bootstrap/utilities/_align.scss +8 -0
- data/_sass/bootstrap/utilities/_background.scss +19 -0
- data/_sass/bootstrap/utilities/_borders.scss +75 -0
- data/_sass/bootstrap/utilities/_clearfix.scss +3 -0
- data/_sass/bootstrap/utilities/_display.scss +26 -0
- data/_sass/bootstrap/utilities/_embed.scss +39 -0
- data/_sass/bootstrap/utilities/_flex.scss +51 -0
- data/_sass/bootstrap/utilities/_float.scss +11 -0
- data/_sass/bootstrap/utilities/_overflow.scss +5 -0
- data/_sass/bootstrap/utilities/_position.scss +32 -0
- data/_sass/bootstrap/utilities/_screenreaders.scss +11 -0
- data/_sass/bootstrap/utilities/_shadows.scss +6 -0
- data/_sass/bootstrap/utilities/_sizing.scss +20 -0
- data/_sass/bootstrap/utilities/_spacing.scss +73 -0
- data/_sass/bootstrap/utilities/_stretched-link.scss +19 -0
- data/_sass/bootstrap/utilities/_text.scss +72 -0
- data/_sass/bootstrap/utilities/_visibility.scss +13 -0
- data/_sass/bootstrap/vendor/_rfs.scss +204 -0
- data/assets/css/asciidocsy.scss +9 -0
- data/assets/css/asciidoctor.css +776 -0
- data/assets/css/bootstrap-toc.css +60 -0
- data/assets/css/bootstrap.scss +4 -0
- data/assets/css/custom.css +2 -0
- data/assets/css/font-awesome.css +2337 -0
- data/assets/css/font-awesome.min.css +4 -0
- data/assets/css/jquery.navgoco.css +69 -0
- data/assets/css/palette.css +217 -0
- data/assets/css/skins/colony.css +734 -0
- data/assets/css/skins/foundation-lime.css +727 -0
- data/assets/css/skins/foundation-potion.css +727 -0
- data/assets/css/skins/foundation.css +720 -0
- data/assets/css/skins/github.css +741 -0
- data/assets/css/skins/golo.css +738 -0
- data/assets/css/skins/iconic.css +762 -0
- data/assets/css/skins/maker.css +738 -0
- data/assets/css/skins/readthedocs.css +739 -0
- data/assets/css/skins/riak.css +759 -0
- data/assets/css/skins/rocket-panda.css +734 -0
- data/assets/css/skins/rubygems.css +722 -0
- data/assets/css/syntax/hljs/a11y-dark.css +99 -0
- data/assets/css/syntax/hljs/a11y-light.css +99 -0
- data/assets/css/syntax/hljs/agate.css +108 -0
- data/assets/css/syntax/hljs/an-old-hope.css +89 -0
- data/assets/css/syntax/hljs/androidstudio.css +66 -0
- data/assets/css/syntax/hljs/arduino-light.css +87 -0
- data/assets/css/syntax/hljs/arta.css +73 -0
- data/assets/css/syntax/hljs/ascetic.css +45 -0
- data/assets/css/syntax/hljs/atelier-cave-dark.css +83 -0
- data/assets/css/syntax/hljs/atelier-cave-light.css +85 -0
- data/assets/css/syntax/hljs/atelier-dune-dark.css +69 -0
- data/assets/css/syntax/hljs/atelier-dune-light.css +69 -0
- data/assets/css/syntax/hljs/atelier-estuary-dark.css +84 -0
- data/assets/css/syntax/hljs/atelier-estuary-light.css +84 -0
- data/assets/css/syntax/hljs/atelier-forest-dark.css +69 -0
- data/assets/css/syntax/hljs/atelier-forest-light.css +69 -0
- data/assets/css/syntax/hljs/atelier-heath-dark.css +69 -0
- data/assets/css/syntax/hljs/atelier-heath-light.css +69 -0
- data/assets/css/syntax/hljs/atelier-lakeside-dark.css +69 -0
- data/assets/css/syntax/hljs/atelier-lakeside-light.css +69 -0
- data/assets/css/syntax/hljs/atelier-plateau-dark.css +84 -0
- data/assets/css/syntax/hljs/atelier-plateau-light.css +84 -0
- data/assets/css/syntax/hljs/atelier-savanna-dark.css +84 -0
- data/assets/css/syntax/hljs/atelier-savanna-light.css +84 -0
- data/assets/css/syntax/hljs/atelier-seaside-dark.css +69 -0
- data/assets/css/syntax/hljs/atelier-seaside-light.css +69 -0
- data/assets/css/syntax/hljs/atelier-sulphurpool-dark.css +69 -0
- data/assets/css/syntax/hljs/atelier-sulphurpool-light.css +69 -0
- data/assets/css/syntax/hljs/atom-one-dark-reasonable.css +75 -0
- data/assets/css/syntax/hljs/atom-one-dark.css +96 -0
- data/assets/css/syntax/hljs/atom-one-light.css +96 -0
- data/assets/css/syntax/hljs/brown-paper.css +64 -0
- data/assets/css/syntax/hljs/brown-papersq.png +0 -0
- data/assets/css/syntax/hljs/codepen-embed.css +60 -0
- data/assets/css/syntax/hljs/color-brewer.css +71 -0
- data/assets/css/syntax/hljs/darcula.css +74 -0
- data/assets/css/syntax/hljs/dark.css +63 -0
- data/assets/css/syntax/hljs/default.css +99 -0
- data/assets/css/syntax/hljs/docco.css +97 -0
- data/assets/css/syntax/hljs/dracula.css +76 -0
- data/assets/css/syntax/hljs/far.css +71 -0
- data/assets/css/syntax/hljs/foundation.css +89 -0
- data/assets/css/syntax/hljs/github-gist.css +79 -0
- data/assets/css/syntax/hljs/github.css +99 -0
- data/assets/css/syntax/hljs/gml.css +78 -0
- data/assets/css/syntax/hljs/googlecode.css +89 -0
- data/assets/css/syntax/hljs/gradient-dark.css +122 -0
- data/assets/css/syntax/hljs/gradient-light.css +130 -0
- data/assets/css/syntax/hljs/grayscale.css +101 -0
- data/assets/css/syntax/hljs/gruvbox-dark.css +108 -0
- data/assets/css/syntax/hljs/gruvbox-light.css +108 -0
- data/assets/css/syntax/hljs/hopscotch.css +84 -0
- data/assets/css/syntax/hljs/hybrid.css +102 -0
- data/assets/css/syntax/hljs/idea.css +97 -0
- data/assets/css/syntax/hljs/ir-black.css +73 -0
- data/assets/css/syntax/hljs/isbl-editor-dark.css +112 -0
- data/assets/css/syntax/hljs/isbl-editor-light.css +111 -0
- data/assets/css/syntax/hljs/kimbie.dark.css +74 -0
- data/assets/css/syntax/hljs/kimbie.light.css +74 -0
- data/assets/css/syntax/hljs/lightfair.css +88 -0
- data/assets/css/syntax/hljs/lioshi.css +88 -0
- data/assets/css/syntax/hljs/magula.css +70 -0
- data/assets/css/syntax/hljs/mono-blue.css +56 -0
- data/assets/css/syntax/hljs/monokai-sublime.css +83 -0
- data/assets/css/syntax/hljs/monokai.css +71 -0
- data/assets/css/syntax/hljs/night-owl.css +182 -0
- data/assets/css/syntax/hljs/nnfx-dark.css +106 -0
- data/assets/css/syntax/hljs/nnfx.css +106 -0
- data/assets/css/syntax/hljs/nord.css +309 -0
- data/assets/css/syntax/hljs/obsidian.css +88 -0
- data/assets/css/syntax/hljs/ocean.css +74 -0
- data/assets/css/syntax/hljs/paraiso-dark.css +72 -0
- data/assets/css/syntax/hljs/paraiso-light.css +72 -0
- data/assets/css/syntax/hljs/pojoaque.css +83 -0
- data/assets/css/syntax/hljs/pojoaque.jpg +0 -0
- data/assets/css/syntax/hljs/purebasic.css +96 -0
- data/assets/css/syntax/hljs/qtcreator_dark.css +83 -0
- data/assets/css/syntax/hljs/qtcreator_light.css +83 -0
- data/assets/css/syntax/hljs/railscasts.css +106 -0
- data/assets/css/syntax/hljs/rainbow.css +85 -0
- data/assets/css/syntax/hljs/routeros.css +108 -0
- data/assets/css/syntax/hljs/school-book.css +69 -0
- data/assets/css/syntax/hljs/school-book.png +0 -0
- data/assets/css/syntax/hljs/shades-of-purple.css +96 -0
- data/assets/css/syntax/hljs/solarized-dark.css +84 -0
- data/assets/css/syntax/hljs/solarized-light.css +84 -0
- data/assets/css/syntax/hljs/srcery.css +78 -0
- data/assets/css/syntax/hljs/stackoverflow-dark.css +78 -0
- data/assets/css/syntax/hljs/stackoverflow-light.css +78 -0
- data/assets/css/syntax/hljs/sunburst.css +102 -0
- data/assets/css/syntax/hljs/tomorrow-night-blue.css +75 -0
- data/assets/css/syntax/hljs/tomorrow-night-bright.css +74 -0
- data/assets/css/syntax/hljs/tomorrow-night-eighties.css +74 -0
- data/assets/css/syntax/hljs/tomorrow-night.css +75 -0
- data/assets/css/syntax/hljs/tomorrow.css +72 -0
- data/assets/css/syntax/hljs/vs.css +68 -0
- data/assets/css/syntax/hljs/vs2015.css +115 -0
- data/assets/css/syntax/hljs/xcode.css +104 -0
- data/assets/css/syntax/hljs/xt256.css +92 -0
- data/assets/css/syntax/hljs/zenburn.css +80 -0
- data/assets/fonts/FontAwesome.otf +0 -0
- data/assets/fonts/fontawesome-webfont.eot +0 -0
- data/assets/fonts/fontawesome-webfont.svg +2671 -0
- data/assets/fonts/fontawesome-webfont.ttf +0 -0
- data/assets/fonts/fontawesome-webfont.woff +0 -0
- data/assets/fonts/fontawesome-webfont.woff2 +0 -0
- data/assets/images/asciidocsy-nav-model.png +0 -0
- data/assets/images/asciidocsy-screenshot.png +0 -0
- data/assets/images/docops-labs-logo.png +0 -0
- data/assets/images/favicons/favicon-16x16.png +0 -0
- data/assets/images/favicons/favicon-32x32.png +0 -0
- data/assets/images/favicons/favicon.ico +0 -0
- data/assets/images/github-repo-download_screenshot.png +0 -0
- data/assets/images/logo-full.png +0 -0
- data/assets/images/logo.png +0 -0
- data/assets/images/logo.svg +87 -0
- data/assets/images/search-by-algolia-light-background.svg +1 -0
- data/assets/images/thumb-topic-data-source-edit.png +0 -0
- data/assets/js/anchor.min.js +9 -0
- data/assets/js/asciidoctor.min.js +1472 -0
- data/assets/js/bootstrap-toc.js +180 -0
- data/assets/js/bootstrap.min.js +7 -0
- data/assets/js/highlight.pack.js +870 -0
- data/assets/js/jquery-3.3.1.js +10364 -0
- data/assets/js/jquery-3.3.1.min.js +2 -0
- data/assets/js/jquery.cookie.js +114 -0
- data/assets/js/jquery.navgoco.js +314 -0
- data/assets/js/semantics.js +58 -0
- data/assets/js/tabber.js +111 -0
- data/assets/js/tail.js +37 -0
- data/assets/js/toggler.js +50 -0
- data/lib/asciidocsy/data/dependencies.yml +142 -0
- data/lib/asciidocsy/data/releases.yml +245 -0
- data/lib/asciidocsy/templates/notice-file.txt +16 -0
- data/lib/asciidocsy/version.rb +13 -0
- data/lib/asciidocsy.rb +1 -0
- metadata +462 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 7ab98f50a5e9108e60b8d0843ee341da2b1f2baa3d5b4c26326459bbdb50a0f7
|
4
|
+
data.tar.gz: 4b101406f7dfc6955e6875f808bdaaf3e160081ea5dafb2a899e2232d97c5836
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7b612860faf4170cff80c43f44512524ddb9cd417826c9b33777ae064c09c2b169be302a7124e3b6be0003fae091c4ef28977ba2a1564a902d58df340bb23534
|
7
|
+
data.tar.gz: a2eb9792421472d5964516ccc01135fa72fb3bd9a1df671cbcc6416afcdddff8b1f3d32153a4911b0fe9c5f195d2baa5e7aebd9fc21e2bfbd1190b4d5352fc56
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/_config.yml
ADDED
@@ -0,0 +1,66 @@
|
|
1
|
+
# Welcome to AsciiDocsy!
|
2
|
+
#
|
3
|
+
# This is a "default" Jekyll config file for this theme, but it is probably
|
4
|
+
# not what you want to use in production.
|
5
|
+
# Be sure to check out the README, which contextualizes this project and
|
6
|
+
# points to the official theme documentation.
|
7
|
+
#
|
8
|
+
# See also https://jekyllrb.com/docs/configuration/default/ for more
|
9
|
+
# configuration options.
|
10
|
+
#
|
11
|
+
# Global custom properties
|
12
|
+
title: My AsciiDocsy-based Site
|
13
|
+
tagline: A site built with the AsciiDoc-ready Jekyll theme for technical documentation
|
14
|
+
deploy_url: https://docs.example.com # your site's URL
|
15
|
+
canonical_url: https://docs.example.com # URL of original content
|
16
|
+
# DO NOT CHANGE the canonical URL if you deploy a copy the AsciiDocsy site
|
17
|
+
# DO change it if you replace all the content or start from scratch
|
18
|
+
company_name: ACME Everything
|
19
|
+
source_git: git@github.com:DocOps/MY-PROJECT.git # git@-formatted address
|
20
|
+
source_www: https://github.com/example-account/MY-PROJECT
|
21
|
+
|
22
|
+
# Sitewide Jekyll settings
|
23
|
+
baseurl: "" # Leave blank if your site will deploy at the root of a domain
|
24
|
+
# such as http://docs.yourcompany.com/
|
25
|
+
# The following paths are all relative to the project base
|
26
|
+
source: .
|
27
|
+
destination: _site
|
28
|
+
layouts_dir: _layouts
|
29
|
+
includes_dir: _includes
|
30
|
+
|
31
|
+
# Global AsciiDocsy settings
|
32
|
+
theme_dir: assets # path to asset SOURCE directories (css/ images/ js/ etc)
|
33
|
+
assets_url: assets # baseurl to assets (default: assets)
|
34
|
+
data_dir: _data
|
35
|
+
source_icon: fa fa-github
|
36
|
+
source_trunk_branch: main # path from repo home url to projet root
|
37
|
+
|
38
|
+
# tag::asciidoctor[]
|
39
|
+
asciidoc: {}
|
40
|
+
asciidoctor:
|
41
|
+
ext: adoc
|
42
|
+
safe: 0
|
43
|
+
base_dir: .
|
44
|
+
attributes:
|
45
|
+
outfilesuffix: ''
|
46
|
+
example-capition: ''
|
47
|
+
experimental:
|
48
|
+
imagesdir: /images
|
49
|
+
icons: font
|
50
|
+
source-highlighter: highlight.js
|
51
|
+
# end::asciidoctor[]
|
52
|
+
|
53
|
+
liquid:
|
54
|
+
error_mode: warn
|
55
|
+
strict_filters: false
|
56
|
+
strict_variables: false
|
57
|
+
|
58
|
+
# Paths to render with Jekyll that would not be rendered by default
|
59
|
+
include:
|
60
|
+
- _data/terms-dict.json
|
61
|
+
|
62
|
+
# Paths to skip that would normally be rendered
|
63
|
+
exclude:
|
64
|
+
- "**/README.adoc" # if we want content from READMEs, we include:: it
|
65
|
+
- COPYRIGHT
|
66
|
+
- LICENSE
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# Content of alert messages
|
2
|
+
gdpr-message:
|
3
|
+
# NOT YET IMPLEMENTED
|
4
|
+
# see features.actions.gdpr-alert for more settings
|
5
|
+
name: Cookies & Privacy
|
6
|
+
show:
|
7
|
+
line: Select cookies to accept.
|
8
|
+
text: | # AsciiDoc formatting allowed
|
9
|
+
This website stores cookies on your computer.
|
10
|
+
These cookies keep track of how you prefer to interact with our website and customize your browsing experience. *We and our vendors do _not_ track you elsewhere on the Internet.* To find out more, see our link:/privacy[Privacy Policy].
|
11
|
+
icon: fa fa-exclamation-circle
|
12
|
+
form: banner
|
13
|
+
when: load
|
14
|
+
call-to-action:
|
15
|
+
# NOT YET IMPLEMENTED
|
16
|
+
show:
|
17
|
+
text: |
|
18
|
+
Don't leave the site without signing up for a demo or at least getting on our mailing list!
|
19
|
+
icon: fa fa-hand-o
|
20
|
+
form: modal
|
21
|
+
when: exit
|
@@ -0,0 +1,33 @@
|
|
1
|
+
$doc:
|
2
|
+
desc: Placement and design of various layout elements.
|
3
|
+
page-header:
|
4
|
+
$doc:
|
5
|
+
desc: Settings for the `header` area of the layout
|
6
|
+
args:
|
7
|
+
show_logo_source: {type: String, desc: "Path of header logo image file; allows Liquid"}
|
8
|
+
show_logo_width: {type: String, desc: "Width of the header logo image"}
|
9
|
+
show:
|
10
|
+
logo:
|
11
|
+
source: "{{ images_url }}/logo.png"
|
12
|
+
width: 50px
|
13
|
+
page-footer:
|
14
|
+
$doc:
|
15
|
+
desc: Settings for the `footer` area of the layout
|
16
|
+
args:
|
17
|
+
show_logo_source: {type: String, desc: "Path of footer logo image file; allows Liquid"}
|
18
|
+
show_logo_width: {type: String, desc: Width of the footer logo image}
|
19
|
+
opts_first-col-class: {type: String, desc: The class of the first column in the footer}
|
20
|
+
show:
|
21
|
+
logo:
|
22
|
+
source: "{{ images_url }}/docops-labs-logo.png"
|
23
|
+
width: 150px
|
24
|
+
opts:
|
25
|
+
class: "row flex-xl-nowrap"
|
26
|
+
first-col-class: offset-2 # how far to offset the link columns
|
27
|
+
social-links:
|
28
|
+
$doc:
|
29
|
+
desc: Settings for social links.
|
30
|
+
args:
|
31
|
+
show_spot: Where in the layout to place the social links.
|
32
|
+
show:
|
33
|
+
spot: footer
|
@@ -0,0 +1,72 @@
|
|
1
|
+
# Defines forms
|
2
|
+
$doc:
|
3
|
+
desc: Ad-hoc forms for the theme.
|
4
|
+
feedback-form:
|
5
|
+
$doc:
|
6
|
+
desc: Populates the feedback form and results.
|
7
|
+
args:
|
8
|
+
show_name:
|
9
|
+
show_text:
|
10
|
+
show_icon:
|
11
|
+
send_opts:
|
12
|
+
type: Array
|
13
|
+
desc: |
|
14
|
+
Array items are objects that contain:
|
15
|
+
+
|
16
|
+
[horizontal]
|
17
|
+
`slug`::: Required, value string.
|
18
|
+
`text`::: Optional, text label to show.
|
19
|
+
`echo`::: Response to show after this option is selected.
|
20
|
+
`icon`::: Optional, icon to display for this option.
|
21
|
+
show:
|
22
|
+
name: Feedback, please.
|
23
|
+
text: Did you find this page helpful?
|
24
|
+
icon: fa fa-clipboard
|
25
|
+
send:
|
26
|
+
opts:
|
27
|
+
- slug: 'yes'
|
28
|
+
text: 'Yes'
|
29
|
+
echo: |
|
30
|
+
That's great! Do let us know if you have more to say.
|
31
|
+
icon: fa fa-trophy
|
32
|
+
- slug: 'no'
|
33
|
+
text: 'No'
|
34
|
+
echo: |
|
35
|
+
We are sorry to hear that.
|
36
|
+
|
37
|
+
More text
|
38
|
+
icon: frown-o
|
39
|
+
- slug: some
|
40
|
+
text: Partly
|
41
|
+
echo: |
|
42
|
+
Okay, thanks for your honesty.
|
43
|
+
|
44
|
+
More text
|
45
|
+
icon: fa fa-line-chart
|
46
|
+
gdpr-alert:
|
47
|
+
$doc:
|
48
|
+
name: GDPR Alert
|
49
|
+
desc: NOT YET IMPLEMENTED.
|
50
|
+
sign:
|
51
|
+
text: I accept.
|
52
|
+
icon: fa fa-thumbs-up
|
53
|
+
pick:
|
54
|
+
text: Customize cookies.
|
55
|
+
icon: fa fa-edit
|
56
|
+
opts:
|
57
|
+
# Cookie types
|
58
|
+
- name: Essential
|
59
|
+
slug: essential
|
60
|
+
desc: These are cookies that are essential for the website to work correctly.
|
61
|
+
- name: Site Preferences
|
62
|
+
slug: preferences
|
63
|
+
desc: These are cookies that are related to your site preferences, e.g. remembering your username, site colours, etc.
|
64
|
+
- name: Analytics
|
65
|
+
slug: analytics
|
66
|
+
desc: Cookies related to site visits, browser types, etc.
|
67
|
+
- name: Marketing
|
68
|
+
slug: marketing
|
69
|
+
desc: Cookies related to marketing, e.g. newsletters, social media, etc
|
70
|
+
deny:
|
71
|
+
# the user action is to make the message go away and eliminate cookies
|
72
|
+
icon: fa fa-thumbs-down
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# Defines navigation elements in the theme
|
2
|
+
$doc:
|
3
|
+
desc: All navigation elements are defined here.
|
4
|
+
anchor-links:
|
5
|
+
$doc:
|
6
|
+
name: Anchor Links
|
7
|
+
desc: Adds self-referential links to all headers of the listed types.
|
8
|
+
args:
|
9
|
+
show_list:
|
10
|
+
type: String
|
11
|
+
desc: Comma-delimited list of heading elements to bookmark
|
12
|
+
show:
|
13
|
+
list: h2,h3,h4,h5 # make empty to disable anchor links
|
14
|
+
subject-menu:
|
15
|
+
$doc:
|
16
|
+
name: Subject Menu
|
17
|
+
desc: Determines the source and display of the _subject_ navigation menu.
|
18
|
+
args:
|
19
|
+
opts_show_type_icons:
|
20
|
+
type: String
|
21
|
+
opts:
|
22
|
+
show_type_icons: false
|
23
|
+
toc:
|
24
|
+
$doc:
|
25
|
+
name: Table of Contents
|
26
|
+
desc: Shows and sets the depth of the table of contents for a topic/page.
|
27
|
+
args:
|
28
|
+
show_text: Text label for the TOC
|
29
|
+
show_spot: Where the TOC will go
|
30
|
+
show_opts_header-level-depth: What header level to reflect in TOC
|
31
|
+
show:
|
32
|
+
text: In this topic…
|
33
|
+
spot: "#sidebar-right"
|
34
|
+
opts:
|
35
|
+
header-level-depth: "h3"
|
36
|
+
breadcrumbs:
|
37
|
+
$doc:
|
38
|
+
name: Page Breadcrumbs
|
39
|
+
desc: Displays and designs the breadcrumb trail.
|
40
|
+
tips:
|
41
|
+
- Crumb paths are further defined in data/manifest.yml.
|
42
|
+
args:
|
43
|
+
show_home:
|
44
|
+
type: String
|
45
|
+
desc: The label for the base crumb
|
46
|
+
dflt: Home
|
47
|
+
show_opts_delim:
|
48
|
+
type: String
|
49
|
+
desc: Character(s) to insert between crumbs
|
50
|
+
show:
|
51
|
+
home: Home
|
52
|
+
opts:
|
53
|
+
delim: ">" # defaults to "/"
|
@@ -0,0 +1,83 @@
|
|
1
|
+
# Defines link elements to appear in pages of various types
|
2
|
+
$doc:
|
3
|
+
skip: true
|
4
|
+
topic: # order these objects as you wish them to appear
|
5
|
+
$doc:
|
6
|
+
desc: Topic-specific functions and links
|
7
|
+
name: "Page Actions: Topic"
|
8
|
+
peel: # display print-friendly version
|
9
|
+
$doc:
|
10
|
+
desc: Make the page print-friendly by removing the sidebars.
|
11
|
+
args: {"text":,"icon":,"func":}
|
12
|
+
text: Print-friendly
|
13
|
+
icon: fa fa-newspaper-o
|
14
|
+
func: ""
|
15
|
+
# role: auth0 # explicitly sets role limit
|
16
|
+
edit:
|
17
|
+
$doc:
|
18
|
+
desc: Link to edit this topic in Git.
|
19
|
+
args: {"text":,"icon":}
|
20
|
+
text: Edit this topic
|
21
|
+
icon: fa fa-pencil-square
|
22
|
+
# role: auth0 # explicitly sets role limit
|
23
|
+
# fork: # overrides default forking policy
|
24
|
+
data:
|
25
|
+
$doc:
|
26
|
+
desc: Link to edit this topic datasource in Git.
|
27
|
+
args: {"text":,"icon":}
|
28
|
+
text: Edit topic datasource
|
29
|
+
icon: fa fa-database
|
30
|
+
# role: auth0
|
31
|
+
# fork: # overrides default forking policy
|
32
|
+
make:
|
33
|
+
$doc:
|
34
|
+
desc: Link to make a new topic in Git.
|
35
|
+
args: {"text":,"icon":}
|
36
|
+
text: Create a (sub)topic
|
37
|
+
icon: fa fa-file-text-o
|
38
|
+
# role: auth0
|
39
|
+
# fork: # overrides default forking policy
|
40
|
+
open-docs:
|
41
|
+
$doc:
|
42
|
+
name: Open Docs Ticket
|
43
|
+
desc: Link to making a docs ticket.
|
44
|
+
args: {"text":,"icon":,"path": Path to append to the `tickets_www` URL}
|
45
|
+
text: Open a docs ticket.
|
46
|
+
icon: fa fa-ticket
|
47
|
+
path: /new?labels=documentation
|
48
|
+
# role: auth0
|
49
|
+
# fork: # overrides default forking policy
|
50
|
+
open-subj:
|
51
|
+
$doc:
|
52
|
+
name: Open Subject Ticket
|
53
|
+
desc: Link to making a subject (product) ticket.
|
54
|
+
args: {"text":,"icon":,"path": Path to append to the `tickets_www` URL}
|
55
|
+
text: Open a product ticket.
|
56
|
+
icon: fa fa-tag
|
57
|
+
path: /new
|
58
|
+
# role: auth0
|
59
|
+
page:
|
60
|
+
edit:
|
61
|
+
$doc:
|
62
|
+
desc: Link to edit this page.
|
63
|
+
args: {"text":,"icon":}
|
64
|
+
text: Edit this page in Git.
|
65
|
+
icon: fa fa-pencil
|
66
|
+
# role: auth0
|
67
|
+
# fork: # overrides default forking policy
|
68
|
+
data:
|
69
|
+
$doc:
|
70
|
+
desc: Link to edit this page's datasource.
|
71
|
+
args: {"text":,"icon":}
|
72
|
+
text: Edit page datasource in Git.
|
73
|
+
icon: fa fa-database
|
74
|
+
# role: auth0
|
75
|
+
# fork: # overrides default forking policy
|
76
|
+
make:
|
77
|
+
$doc:
|
78
|
+
desc: Create a new page in Git.
|
79
|
+
args: {"text":,"icon":}
|
80
|
+
text: Suggest a new page
|
81
|
+
icon: fa fa-file-text-o
|
82
|
+
# role: auth0
|
83
|
+
# fork: # overrides default forking policy
|
@@ -0,0 +1,68 @@
|
|
1
|
+
$doc:
|
2
|
+
desc: Defines policies regarding privacy, content display, access, etc.
|
3
|
+
cookies: # cookie policies will go here
|
4
|
+
gdpr:
|
5
|
+
# NOT YET IMPLEMENTED
|
6
|
+
# This feature will enable users to
|
7
|
+
$doc:
|
8
|
+
name: GDPR Policies
|
9
|
+
desc: Groups cookies by use to let users select which cookies to permit.
|
10
|
+
args:
|
11
|
+
types:
|
12
|
+
desc: |
|
13
|
+
The categories of cookies users can toggle on/off.
|
14
|
+
|
15
|
+
`slug`:: Slug for the category.
|
16
|
+
`text`:: User-facing descriptor for the category.
|
17
|
+
`cookies`:: Array of cookie names in the category.
|
18
|
+
types:
|
19
|
+
- slug: essential
|
20
|
+
text: Just the cookie to remember these preferences.
|
21
|
+
cookies: [cookieControlPrefs]
|
22
|
+
- slug: preferences
|
23
|
+
text: Cookies to recall style and version choices made in the app.
|
24
|
+
cookies: [syntax-style,skin-style,switcher_user-os]
|
25
|
+
- slug: analytics
|
26
|
+
text: Uses cookies to anonymously report how you use the site so we can improve the experience.
|
27
|
+
cookies: [google-analytics]
|
28
|
+
- slug: commercial
|
29
|
+
text: We don't use this kind of cookie anywhere on our site.
|
30
|
+
cookies: []
|
31
|
+
authorizations:
|
32
|
+
# NOT YET IMPLEMENTED
|
33
|
+
# Arbitrary tiers for referencing in other settings.
|
34
|
+
# Authorization is ordered from lowest (first) to highest.
|
35
|
+
# This object demonstrates only FEATURE-level permissions for page links.
|
36
|
+
# Restricting access to whole pages/paths based on authorizations is
|
37
|
+
# not yet planned.
|
38
|
+
- code: auth0
|
39
|
+
text: all site visitors
|
40
|
+
policies:
|
41
|
+
fork: togo
|
42
|
+
- code: auth1
|
43
|
+
text: logged-in site visitors
|
44
|
+
keys:
|
45
|
+
- cookie: employees
|
46
|
+
- cookie: contractors
|
47
|
+
- token: staff
|
48
|
+
policies:
|
49
|
+
fork: stay
|
50
|
+
- code: auth2
|
51
|
+
text: site admins only
|
52
|
+
keys:
|
53
|
+
- cookie: 'admins'
|
54
|
+
policies:
|
55
|
+
fork: stay
|
56
|
+
# NOTE: with a static site, we are not so much protecting the source
|
57
|
+
# (our Git workflow does that); we are just restricting what visitors
|
58
|
+
# see on the page.
|
59
|
+
defaults:
|
60
|
+
# auth: auth0 # who sees interactive features on the site?
|
61
|
+
# must be one of the codes listed in policies.authorizations
|
62
|
+
# can override individually below
|
63
|
+
fork: upto # can users fork the repo to contribute?
|
64
|
+
# none = no forking or branching
|
65
|
+
# stay = branch only
|
66
|
+
# togo = fork only
|
67
|
+
# upto = fork or branch, user's choice
|
68
|
+
# auth = set under policies.authorizations
|