asciidocsy-jekyll-theme 0.3.0.pre.dev

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 115efbd280c39ebae006952d418b357cbd1bc0e2c0c5f1fd58f65dff3ef96c76
+  data.tar.gz: 6b650eb9560e8f37903d7deab738b2e8914e4d062e0477670afbcc1529c7a8f5
+SHA512:
+  metadata.gz: acad2de6f29a98ddcaf4ce6308db8967396b55267c6dca8d07f6ef7a041c5003ef47470fc49070bfad632bcf6f34f7d354dc3707068df18dcced3fa084662d33
+  data.tar.gz: 3b37bad604ddf86d8352ea3dca7be55b45deec7390a3a6115d3398332a400b2876895507d46b8711eaa26d42de0617754ecde5f01c68c1ffb97e62200b1a45e1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/_config.yml

@@ -0,0 +1,66 @@
+# Welcome to AsciiDocsy!
+#
+# This is a "default" Jekyll config file for this theme, but it is probably
+# not what you want to use in production.
+# Be sure to check out the README, which contextualizes this project and
+#  points to the official theme documentation.
+#
+# See also https://jekyllrb.com/docs/configuration/default/ for more
+#  configuration options.
+#
+# Global custom properties
+title: My AsciiDocsy-based Site
+tagline: A site built with the AsciiDoc-ready Jekyll theme for technical documentation
+deploy_url: https://docs.example.com # your site's URL
+canonical_url: https://docs.example.com # URL of original content
+# DO NOT CHANGE the canonical URL if you deploy a copy the AsciiDocsy site
+# DO change it if you replace all the content or start from scratch
+company_name: ACME Everything
+source_git: git@github.com:DocOps/MY-PROJECT.git # git@-formatted address
+source_www: https://github.com/example-account/MY-PROJECT
+
+# Sitewide Jekyll settings
+baseurl: "" # Leave blank if your site will deploy at the root of a domain
+            #  such as http://docs.yourcompany.com/
+# The following paths are all relative to the project base
+source: .
+destination: _site
+layouts_dir: _layouts
+includes_dir: _includes
+
+# Global AsciiDocsy settings
+theme_dir: assets # path to asset SOURCE directories (css/ images/ js/ etc)
+assets_url: assets # baseurl to assets (default: assets)
+data_dir: _data
+source_icon: fa fa-github
+source_trunk_branch: main # path from repo home url to projet root
+
+# tag::asciidoctor[]
+asciidoc: {}
+asciidoctor:
+  ext: adoc
+  safe: 0
+  base_dir: .
+  attributes:
+    outfilesuffix: ''
+    example-capition: ''
+    experimental:
+    imagesdir: /images
+    icons: font
+    source-highlighter: highlight.js
+# end::asciidoctor[]
+
+liquid:
+  error_mode: warn
+  strict_filters: false
+  strict_variables: false
+
+# Paths to render with Jekyll that would not be rendered by default
+include:
+  - _data/terms-dict.json
+
+# Paths to skip that would normally be rendered
+exclude:
+  - "**/README.adoc" # if we want content from READMEs, we include:: it
+  - COPYRIGHT
+  - LICENSE

data/_data/theme/alerts.yml

@@ -0,0 +1,21 @@
+# Content of alert messages
+gdpr-message:
+  # NOT YET IMPLEMENTED
+  # see features.actions.gdpr-alert for more settings
+  name: Cookies & Privacy
+  show:
+    line: Select cookies to accept.
+    text: | # AsciiDoc formatting allowed
+      This website stores cookies on your computer.
+      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].
+    icon: fa fa-exclamation-circle
+    form: banner
+    when: load
+call-to-action:
+  # NOT YET IMPLEMENTED
+  show:
+    text: |
+      Don't leave the site without signing up for a demo or at least getting on our mailing list!
+    icon: fa fa-hand-o
+    form: modal
+    when: exit

data/_data/theme/blocks.yml

@@ -0,0 +1,33 @@
+$doc:
+  desc: Placement and design of various layout elements.
+page-header:
+  $doc:
+    desc: Settings for the `header` area of the layout
+    args:
+      show_logo_source: {type: String, desc: "Path of header logo image file; allows Liquid"}
+      show_logo_width: {type: String, desc: "Width of the header logo image"}
+  show:
+    logo:
+      source: "{{ images_url }}/logo.png"
+      width: 50px
+page-footer:
+  $doc:
+    desc: Settings for the `footer` area of the layout
+    args:
+      show_logo_source: {type: String, desc: "Path of footer logo image file; allows Liquid"}
+      show_logo_width: {type: String, desc: Width of the footer logo image}
+      opts_first-col-class: {type: String, desc: The class of the first column in the footer}
+  show:
+    logo:
+      source: "{{ images_url }}/docops-labs-logo.png"
+      width: 150px
+    opts:
+      class: "row flex-xl-nowrap"
+      first-col-class: offset-2 # how far to offset the link columns
+social-links:
+  $doc:
+    desc: Settings for social links.
+    args:
+      show_spot: Where in the layout to place the social links.
+  show:
+    spot: footer

data/_data/theme/forms.yml

@@ -0,0 +1,72 @@
+# Defines forms
+$doc:
+  desc: Ad-hoc forms for the theme.
+feedback-form:
+  $doc:
+    desc: Populates the feedback form and results.
+    args:
+      show_name:
+      show_text:
+      show_icon:
+      send_opts:
+        type: Array
+        desc: |
+          Array items are objects that contain:
+          +
+          [horizontal]
+          `slug`::: Required, value string.
+          `text`::: Optional, text label to show.
+          `echo`::: Response to show after this option is selected.
+          `icon`::: Optional, icon to display for this option.
+  show:
+    name: Feedback, please.
+    text: Did you find this page helpful?
+    icon: fa fa-clipboard
+  send:
+    opts:
+      - slug: 'yes'
+        text: 'Yes'
+        echo: |
+          That's great! Do let us know if you have more to say.
+        icon: fa fa-trophy
+      - slug: 'no'
+        text: 'No'
+        echo: |
+          We are sorry to hear that.
+
+          More text
+        icon: frown-o
+      - slug: some
+        text: Partly
+        echo: |
+          Okay, thanks for your honesty.
+
+          More text
+        icon: fa fa-line-chart
+gdpr-alert:
+  $doc:
+    name: GDPR Alert
+    desc: NOT YET IMPLEMENTED.
+  sign:
+    text: I accept.
+    icon: fa fa-thumbs-up
+  pick:
+    text: Customize cookies.
+    icon: fa fa-edit
+    opts:
+      # Cookie types
+      - name: Essential
+        slug: essential
+        desc: These are cookies that are essential for the website to work correctly.
+      - name: Site Preferences
+        slug: preferences
+        desc: These are cookies that are related to your site preferences, e.g. remembering your username, site colours, etc.
+      - name: Analytics
+        slug: analytics
+        desc: Cookies related to site visits, browser types, etc.
+      - name: Marketing
+        slug: marketing
+        desc: Cookies related to marketing, e.g. newsletters, social media, etc
+  deny:
+    # the user action is to make the message go away and eliminate cookies
+    icon: fa fa-thumbs-down

data/_data/theme/navigation.yml

@@ -0,0 +1,53 @@
+# Defines navigation elements in the theme
+$doc:
+  desc: All navigation elements are defined here.
+anchor-links:
+  $doc:
+    name: Anchor Links
+    desc: Adds self-referential links to all headers of the listed types.
+    args:
+      show_list:
+        type: String
+        desc: Comma-delimited list of heading elements to bookmark
+  show:
+    list: h2,h3,h4,h5 # make empty to disable anchor links
+subject-menu:
+  $doc:
+    name: Subject Menu
+    desc: Determines the source and display of the _subject_ navigation menu.
+    args:
+      opts_show_type_icons:
+        type: String
+  opts:
+    show_type_icons: false
+toc:
+  $doc:
+    name: Table of Contents
+    desc: Shows and sets the depth of the table of contents for a topic/page.
+    args:
+      show_text: Text label for the TOC
+      show_spot: Where the TOC will go
+      show_opts_header-level-depth: What header level to reflect in TOC
+  show:
+    text: In this topic…
+    spot: "#sidebar-right"
+    opts:
+      header-level-depth: "h3"
+breadcrumbs:
+  $doc:
+    name: Page Breadcrumbs
+    desc: Displays and designs the breadcrumb trail.
+    tips:
+      - Crumb paths are further defined in data/manifest.yml.
+    args:
+      show_home:
+        type: String
+        desc: The label for the base crumb
+        dflt: Home
+      show_opts_delim:
+        type: String
+        desc: Character(s) to insert between crumbs
+  show:
+    home: Home
+    opts:
+      delim: ">" # defaults to "/"

data/_data/theme/page-actions.yml

@@ -0,0 +1,83 @@
+# Defines link elements to appear in pages of various types
+$doc:
+  skip: true
+topic: # order these objects as you wish them to appear
+  $doc:
+    desc: Topic-specific functions and links
+    name: "Page Actions: Topic"
+  peel: # display print-friendly version
+    $doc:
+      desc: Make the page print-friendly by removing the sidebars.
+      args: {"text":,"icon":,"func":}
+    text: Print-friendly
+    icon: fa fa-newspaper-o
+    func: ""
+    # role: auth0 # explicitly sets role limit
+  edit:
+    $doc:
+      desc: Link to edit this topic in Git.
+      args: {"text":,"icon":}
+    text: Edit this topic
+    icon: fa fa-pencil-square
+    # role: auth0 # explicitly sets role limit
+    # fork: # overrides default forking policy
+  data:
+    $doc:
+      desc: Link to edit this topic datasource in Git.
+      args: {"text":,"icon":}
+    text: Edit topic datasource
+    icon: fa fa-database
+    # role: auth0
+    # fork: # overrides default forking policy
+  make:
+    $doc:
+      desc: Link to make a new topic in Git.
+      args: {"text":,"icon":}
+    text: Create a (sub)topic
+    icon: fa fa-file-text-o
+    # role: auth0
+    # fork: # overrides default forking policy
+  open-docs:
+    $doc:
+      name: Open Docs Ticket
+      desc: Link to making a docs ticket.
+      args: {"text":,"icon":,"path": Path to append to the `tickets_www` URL}
+    text: Open a docs ticket.
+    icon: fa fa-ticket
+    path: /new?labels=documentation
+    # role: auth0
+    # fork: # overrides default forking policy
+  open-subj:
+    $doc:
+      name: Open Subject Ticket
+      desc: Link to making a subject (product) ticket.
+      args: {"text":,"icon":,"path": Path to append to the `tickets_www` URL}
+    text: Open a product ticket.
+    icon: fa fa-tag
+    path: /new
+    # role: auth0
+page:
+  edit:
+    $doc:
+      desc: Link to edit this page.
+      args: {"text":,"icon":}
+    text: Edit this page in Git.
+    icon: fa fa-pencil
+    # role: auth0
+    # fork: # overrides default forking policy
+  data:
+    $doc:
+      desc: Link to edit this page's datasource.
+      args: {"text":,"icon":}
+    text: Edit page datasource in Git.
+    icon: fa fa-database
+    # role: auth0
+    # fork: # overrides default forking policy
+  make:
+    $doc:
+      desc: Create a new page in Git.
+      args: {"text":,"icon":}
+    text: Suggest a new page
+    icon: fa fa-file-text-o
+    # role: auth0
+    # fork: # overrides default forking policy

data/_data/theme/policies.yml

@@ -0,0 +1,68 @@
+$doc:
+  desc: Defines policies regarding privacy, content display, access, etc.
+cookies: # cookie policies will go here
+gdpr:
+  # NOT YET IMPLEMENTED
+  # This feature will enable users to
+  $doc:
+    name: GDPR Policies
+    desc: Groups cookies by use to let users select which cookies to permit.
+    args:
+      types:
+        desc: |
+          The categories of cookies users can toggle on/off.
+
+          `slug`:: Slug for the category.
+          `text`:: User-facing descriptor for the category.
+          `cookies`:: Array of cookie names in the category.
+  types:
+    - slug: essential
+      text: Just the cookie to remember these preferences.
+      cookies: [cookieControlPrefs]
+    - slug: preferences
+      text: Cookies to recall style and version choices made in the app.
+      cookies: [syntax-style,skin-style,switcher_user-os]
+    - slug: analytics
+      text: Uses cookies to anonymously report how you use the site so we can improve the experience.
+      cookies: [google-analytics]
+    - slug: commercial
+      text: We don't use this kind of cookie anywhere on our site.
+      cookies: []
+authorizations:
+  # NOT YET IMPLEMENTED
+  # Arbitrary tiers for referencing in other settings.
+  # Authorization is ordered from lowest (first) to highest.
+  # This object demonstrates only FEATURE-level permissions for page links.
+  # Restricting access to whole pages/paths based on authorizations is
+  #  not yet planned.
+  - code: auth0
+    text: all site visitors
+    policies:
+      fork: togo
+  - code: auth1
+    text: logged-in site visitors
+    keys:
+      - cookie: employees
+      - cookie: contractors
+      - token:  staff
+    policies:
+      fork: stay
+  - code: auth2
+    text: site admins only
+    keys:
+      - cookie: 'admins'
+    policies:
+      fork: stay
+  # NOTE: with a static site, we are not so much protecting the source
+  #  (our Git workflow does that); we are just restricting what visitors
+  #  see on the page.
+defaults:
+  # auth: auth0 # who sees interactive features on the site?
+              # must be one of the codes listed in policies.authorizations
+              # can override individually below
+  fork: upto  # can users fork the repo to contribute?
+              #   none = no forking or branching
+              #   stay = branch only
+              #   togo = fork only
+              #   upto = fork or branch, user's choice
+              #   auth = set under policies.authorizations