owasp-td-jekyll 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 919c9ec3e87568a8bf3c234dce59e8dbe58fbbf47d5970f1cc59791053901b9a
+  data.tar.gz: ab2d412654da2e41c3b0f486057ea2ab39214898954ca05d84c98cabdabcf226
+SHA512:
+  metadata.gz: 067d556cabd97114bce5d5a0f6aa3f5ed813ae7f1dc4da8f3be9209cf0a1d9d733327904df5bda27ff3916492025e9452ee37abe18c7af7d6e2c90cf73097994
+  data.tar.gz: fb1fd6e3119300e1c3e34e31e3fc734bab26dcfab0be33f3484e764a22f1401ca822e7e523d851f974bda7c570a6c92bed83fd5a92889720edad36478e2419b9

data/LICENSE.txt

@@ -0,0 +1,202 @@
+                                 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 2020 Leo Reading
+
+   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/README.md

@@ -0,0 +1,212 @@
+# owasp-td-jekyll
+
+This is a jekyll theme meant to be used as a documentation site as opposed to a blog, specifically being designed for [OWASP Threat Dragon](https://github.com/OWASP/threat-dragon).  It is opinionated on the file structure of your documentation for breadcrumbs to work.  An example documentation file directory:
+```
+|---- environment (group)
+|-------- page_1.md 
+|-------- page_2.md
+|-------- page_3.md
+|---- tools (group)
+|-------- tool_1.md
+|-------- tool_1.md
+|---- macos (group)
+|-------- page_1.md
+|---- windows (group)
+|-------- page_1.md
+|---- linux (group)
+|-------- page_1.md
+```
+
+This theme is based on (Mike Goodwin's original Threat Dragon documentation site)[https://github.com/threatdragon/threatdragon.github.io/tree/original]
+
+
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "owasp-td-jekyll"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: owasp-td-jekyll
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install owasp-td-jekyll
+
+## Usage
+### TLDR;
+Install the gem
+Ensure your pages are structured as `group/page.md`
+Add your config:
+```
+title: OWASP Threat Dragon
+
+theme: owasp-td-jekyll
+
+brand: OWASP Threat Dragon
+faviconUrl: /assets/images/favicon.ico
+
+header_links:
+  - text: Try the web app
+    fa_class: fa fa-flask
+    url: http://threatdragon.org
+
+  - text: Download the desktop app
+    fa_class: fa fa-cloud-download-alt
+    target: _blank
+    url: https://github.com/OWASP/threat-dragon-desktop/releases
+
+  - text: Visit us on GitHub
+    fa_class: fab fa-github
+    target: _blank
+    url: https://github.com/OWASP/threat-dragon
+
+
+nav:
+  categories:
+    - name: Development
+      groups:
+        - name: Environment
+          fa_class: fas fa-layer-group
+        - name: Contributing
+          fa_class: fas fa-user-ninja
+    - name: Threat Modeling
+      groups:
+        - name: Modeling
+          fa_class: fas fa-project-diagram
+        - name: Icons
+          fa_class: fas fa-icons
+
+logo_src: assets/images/threatdragon_logo_image.svg
+homeLinks:
+  - relative_url: something
+    description: This is my description.  There are many like it, but this one is mine.
+    fa_class: fas fa-project-diagram
+  - relative_url: something_else
+    description: This is my description.  There are many like it, but this one is mine.
+    fa_class: fas fa-user-ninja
+
+```
+
+### General Config
+|Name|Type|Description|
+|---|---|---|
+|`brand`|string|The brand name to be used as the home link in the navbar|
+|`faviconUrl`|string|The relative path to the favicon|
+|`header_links`|array<object>|Additional links to be added to the navbar (top, not sidebar)
+|`header_links[0].text`|string|The text of the link|
+|`header_links[0].fa_class`|string|The font-awesome class to use for the dropdown.  Use the full class, eg `fab fa-github`|
+|`header_links[0].url`|string|The url to be used as the href preoprty on the anchor.|
+|`header_links[0].target`|string|The `target` property for the anchor. Optional|
+
+### Sidebar
+The sidebar is used as the primary navigation for the site, unless it is on a smaller device.  The navigation is built from a combination of properties provided in your `_config.yaml` as well as having the `group` and `nav_order` properties set in your (front matter)[https://jekyllrb.com/docs/front-matter/]
+
+|Name|Description|Required|
+|---|---|---|
+|`group`|Top level navigation on the sidebar is based on groups.  Associate a page to a group.  If only one page exists in a group, it is just a link as opposed to a dropdown.|yes|
+|`nav_order`|The order in which to display the link in the navigation (within the group)|no|
+
+Config for the sidebar, to be put in your `_config.yaml`:
+|Name|Type|Description|
+|---|---|---|
+|`nav`|object|The top-level navigation object|
+|`nav.categories`|array<object>|Categories to separate the different menu options.  Used as a logical grouping|
+|`nav.categories[].name`|string|The name of the category.  Used for display purposes|
+|`nav.categories[].groups`|array<object>|The groups (dropdowns) to be used in the category.|
+|`nav.categories[].groups[].name`|string|The name of the group.  This should match the group tag used in your (front matter)[https://jekyllrb.com/docs/front-matter/].  If only a single page exists in a group, the nav will be a link as opposed to drop-down.|
+|`nav.categories[].groups[].fa_class`|string|The font-awesome class to use for the dropdown.  Use the full class, eg `fas fa-user-ninja`|
+
+
+Example nav in `_config.yaml`
+```
+nav:
+  categories:
+    - name: Cat 1
+      groups:
+        - name: My Dropdown
+          fa_class: fas-fa-layer-group
+```
+Example page:
+```
+---
+title: Users
+path: modeling/users
+group: Cat 1
+layout: page
+nav_order: 0
+---
+# Users
+Some more text goes here
+```
+_____
+## Layouts
+
+### Home
+The home page layout is a special layout.  Text is put into the jumbotron, with an optional image (if configured in the config).  Actions may also be configured for this using the `_config.yaml`.  This was set up with the idea of only ever having a single home page.
+
+Home Options (to be set in your `_config.yaml`):
+|Name|Type|Description|Required|
+|---|---|---|---|
+|`logo_src`|string|The location of your main brand logo|no|
+|`homeLinks`|array<object>|The links/actions to display under the main content|no|
+|`homeLinks[].relative_url`|string|To be used as a link to a relative page|yes|
+|`homeLinks[].description`|string|Text to put under the icon|no|
+|`homeLinks[].fa_class`|string|The font-awesome class to use for the dropdown.  Use the full class, eg `fas fa-user-ninja`|yes|
+
+Example home page:
+```
+---
+layout: home
+title: Home
+path: /
+---
+
+# Hello, world!
+This is some content I got going on here, thanks for swinging by...
+```
+
+### Page
+The page layout is the standard layout to be used.  Example page:
+```
+---
+title: Users
+path: modeling/users
+group: Icons
+layout: page
+nav_order: 0
+---
+# Users
+Some more text goes here
+```
+
+____
+## Breadcrumbs
+Breadcrumbs rely on the file structure of your documentation to be as follows: `category/group/page.md`.  Please see the top of the readme for a full example tree.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lreading/owasp-td-jekyll. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Development
+
+To set up your environment to develop this theme, run `bundle install`.
+
+Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+
+When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
+To add a custom directory to your theme-gem, please edit the regexp in `owasp-td-jekyll.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [Apache 2.0 License](http://www.apache.org/licenses/).

data/_includes/head.html

@@ -0,0 +1,11 @@
+
+<head>
+    <title>{{ page.title }}</title>
+
+    <meta charset="utf-8" />
+    <link rel="shortcut icon" href="{{ site.faviconUrl | relative_url }}" type="image/x-icon">
+    <link rel="icon" href="{{ site.faviconUrl | relative_url }}" type="image/x-icon">
+    <link rel="stylesheet" href="{{ '/assets/css/bootstrap.css' | relative_url }}">
+    <link rel="stylesheet" href="{{ '/assets/css/style.css' | relative_url }}">
+    <link rel="stylesheet" href="{{ '/assets/css/fontawesome.min.css' | relative_url }}">
+</head>

data/_includes/navbar.html

@@ -0,0 +1,33 @@
+<nav class="navbar navbar-expand-md navbar-dark bg-primary">
+    <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
+        <span class="navbar-toggler-icon"></span>
+    </button>
+    <a class="navbar-brand" href="{{ '/' | relative_url }}">
+        {{ site.brand }}
+    </a>
+    <div class="collapse navbar-collapse" id="navbarNavDropdown">
+        <ul class="navbar-nav ml-auto">
+            {%- for navlink in site.header_links -%}
+            <li class="nav-item">
+                <a href="{{ navlink.url }}"
+                    {% if navlink.target %} target="{{ navlink.target }}"{%- endif -%}
+                    class="nav-link active">
+                        {%- if navlink.fa_class -%}
+                        <i class="{{ navlink.fa_class }} fa-lg"></i>
+                        {%- endif %} {{ navlink.text }}
+                </a>
+            </li>
+            {%- endfor -%}
+            
+            <!-- Sidebars do not work well on smaller devices.  We want to fall back to a more traditional expanding button navigation -->
+            <li class="nav-item dropdown d-sm-block d-md-none">
+                <a class="nav-link dropdown-toggle" href="#" id="smallerscreenmenu" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"> Menu </a>
+                <div class="dropdown-menu" aria-labelledby="smallerscreenmenu">
+                    {%- for navPage in site.pages | where: "path" -%}
+                        <a class="dropdown-item" href="{{ navPage.url || relative_url }}">{{ navPage.title }}</a>
+                    {%- endfor -%}
+                </div>
+            </li>
+        </ul>
+    </div>
+</nav>