bridgetown-docs-template 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfc2ec8fd72b7bc4ee38a7ab5571589b5af24560110819c52898c6d189d26b0a
-  data.tar.gz: 47d7ce752e127cba3c13e798baf7140547578c36652b20dfb484e78c92e1b46b
+  metadata.gz: e25b58275496d7e549ee2e2b8767503b9662155bb304ff841220c7a98e717602
+  data.tar.gz: 9a4340673cc51d38dfd7ad6b0d09789f1562b17b71d790ded82692dd8e014caf
 SHA512:
-  metadata.gz: fbf0f7b23d37b9c305d9c3b93c8f1dc3410e871038496437354d3889782784f195336acd574c015c4cb78bc7ca802f151058ce2c90b3bc90860dfdb6575c3674
-  data.tar.gz: 7e7e7ce571004980ffc3247278c1ae8d4fd1af459c5c2e0d32e73195bd3294747210a7affbab73651c7d349caaac31d99365787d304b847ade37db985c74087b
+  metadata.gz: d3bb451677cbf1f182ddbbcfcab7f10a0e5d404626779fb4814b75ce168a3e8f07d81c3147ac68e2072dbcb934b9a8ea194a9bdc0b8f0819217c4ede8f61ba3d
+  data.tar.gz: 4c5a6754d232934431113b3b8c2e11ceadb0ccffe308f6eb875b31cd2812a17e56d737f8425cb6a0216be82bdc28bfafe2a98f86d3a79e537549e95aafabf2fa

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Spinal Developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -3,13 +3,13 @@
 A Bridgetown documentation site theme, built with Tailwind CSS.
 
 
-<img src="https://user-images.githubusercontent.com/988051/183708900-d2945c3b-8ff5-4aff-a3c1-98335cc90277.jpg" alt="preview of the Bridgetown documentation theme, built with Tailwind CSS" />
+<img src="https://github.com/spinalcms/bridgetown-docs-template/blob/main/bridgetown-docs-preview.jpg?raw=true" alt="preview of the Bridgetown documentation theme, built with Tailwind CSS" />
 
 
-## Sponsored By [Spinal](https://spinalcms.com/)
+## Sponsored By [Spinal](https://spinalcms.com/cms-for-bridgetown/)
 
-<a href="https://spinalcms.com/" target="_blank">
-  <img src="https://user-images.githubusercontent.com/988051/183079316-af747ef2-42a9-47d8-9a0c-488ed4b6a689.jpg" alt="Spinal CMS logo" width="400" />
+<a href="https://spinalcms.com/cms-for-bridgetown/" target="_blank">
+  <img src="https://user-images.githubusercontent.com/988051/183079316-af747ef2-42a9-47d8-9a0c-488ed4b6a689.jpg" alt="Spinal CMS logo" width="200"/>
 </a>
 
 
@@ -21,6 +21,12 @@ Run this command to add this plugin to your site's Gemfile:
 $ bundle add bridgetown-docs-template -g bridgetown_plugins
 ```
 
+Then add the initializer to your configuration in `config/initializers.rb`:
+
+```ruby
+init :"bridgetown-docs-template"
+```
+
 
 ## Requirements
 
@@ -34,7 +40,7 @@ There are a few requirements for this theme to run.
 
 The following frontmatter is expected in your collection resources:
 
-- layout: bridgetown_docs_template/layout
+- layout: `bridgetown_docs_template/layout`
 - title
 - description
 - category
@@ -42,7 +48,7 @@ The following frontmatter is expected in your collection resources:
 If you want to show the “video” or “quick links” section—likely in your docs root, add `show_videotour: true` and `show_quicklinks: true` to your root's markdown file.
 
 
-### Add the gem's path in the `content` array, like so:
+### Add the gem's path in the `content` array of your Tailwind CSS config, like so:
 
 ```js
 content: [
@@ -66,6 +72,12 @@ The plugin will automatically use any of the following metadata variables if the
 - email
 
 
+## Related repo's
+- [Documentation theme built with Tailwind CSS](https://github.com/SpinalCMS/docs-template)
+- [11ty documentation template using Tailwind CSS](https://github.com/SpinalCMS/11ty-docs-template)
+- [Astro documentation template using Tailwind CSS](https://github.com/SpinalCMS/astro-docs-template)
+
+
 ## Contributing
 
 1. Fork it (https://github.com/spinalcms/bridgetown-docs-template/fork)

data/components/bridgetown_docs_template/navigation_component.erb

@@ -8,9 +8,9 @@
 <div class="fixed top-[3.5rem] h-screen shadow-xl px-4 left-0 hidden peer-checked:block lg:relative lg:top-0 lg:h-auto lg:px-0 lg:block lg:flex-none lg:shadow-none">
   <div class="absolute inset-y-0 right-0 w-full lg:w-[50vw] bg-white lg:bg-slate-50"></div>
 
-  <nav class="sticky top-[4.5rem] w-64 pr-8 text-base lg:text-sm xl:w-72 xl:pr-16">
-    <ul role="list" class="-ml-0.5 h-[calc(100vh-4.5rem)] overflow-y-auto py-7 pl-0.5 space-y-8">
-      <% group_by(@resources, "category").each do |resource| %>
+  <nav class="sticky top-[4.5rem] w-64 text-base lg:text-sm xl:w-72">
+    <ul role="list" class="-ml-0.5 h-[calc(100vh-4.5rem)] overflow-y-auto py-7 pl-0.5 pr-8 space-y-8 xl:pr-16">
+      <% grouped_and_sorted_documentation_resources.each do |resource| %>
         <li>
           <h3 class="font-semibold tracking-tight text-slate-900">
             <%= resource.fetch("name", "No Category").titleize %>
@@ -18,6 +18,8 @@
 
           <ul role="list" class="pl-3 mt-3 space-y-2">
             <% sort(resource.fetch("items", []), "order").each do |item| %>
+              <% next if !item.published? %>
+
               <li>
                 <a href="<%= url_for(item) %>" class="text-slate-900 hover:text-slate-800">
                   <%= item.data.title %>

data/components/bridgetown_docs_template/navigation_component.rb

@@ -2,4 +2,15 @@ class BridgetownDocsTemplate::NavigationComponent < Bridgetown::Component
   def initialize(resources)
     @resources = resources
   end
+
+  def grouped_and_sorted_documentation_resources
+    group_by(@resources, "section")
+      .sort_by { |resources| documentation_sections_order.find_index(resources["name"]) }
+  end
+
+  private
+
+  def documentation_sections_order
+    []
+  end
 end

data/lib/bridgetown-docs-template/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownDocsTemplate
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/bridgetown-docs-template.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 require "bridgetown"
+require "bridgetown-docs-template/version"
 
-Bridgetown::PluginManager.new_source_manifest(
-  origin: BridgetownDocsTemplate,
-  components: File.expand_path("../components", __dir__),
-  layouts: File.expand_path("../layouts", __dir__)
-)
+Bridgetown.initializer :"bridgetown-docs-template" do |config|
+  config.source_manifest(
+    origin: BridgetownDocsTemplate,
+    components: File.expand_path("../components", __dir__),
+    layouts: File.expand_path("../layouts", __dir__)
+  )
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-docs-template
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Spinal CMS Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-10 00:00:00.000000000 Z
+date: 2023-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -68,9 +68,11 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
+- LICENSE.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- bridgetown-docs-preview.jpg
 - bridgetown-docs-template.gemspec
 - components/bridgetown_docs_template/content_footer_component.erb
 - components/bridgetown_docs_template/content_footer_component.rb
@@ -92,7 +94,7 @@ homepage: https://github.com/spinalcms/bridgetown-docs-template
 licenses:
 - MIT
 metadata:
-  yarn-add: bridgetown-docs-template@0.1.0
+  yarn-add: bridgetown-docs-template@0.1.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -108,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: A minimal Bridgetown template for a documentation site using Tailwind CSS.