utopia-project 0.20.3 → 0.22.0

data/readme.md

@@ -2,55 +2,45 @@
 
 A simple Ruby project documentation website.
 
-[![Development Status](https://github.com/socketry/utopia-project/workflows/Test/badge.svg)](https://github.com/socketry/utopia-project/actions?workflow=Test)
+[![Test](https://github.com/socketry/utopia-project/actions/workflows/test.yaml/badge.svg)](https://github.com/socketry/utopia-project/actions/workflows/test.yaml)
 
 ## Motivation
 
-I've used many documentation tools. Most are over-complicated and focus on what is possible rather than what is useful. Because I manage many open source projects, at a certain scale it makes sense to build something to suit your needs rather than try to adapt to existing systems. This is one such instance.
+I've used many documentation tools. Most are over-complicated and focus on what is possible rather than what is useful.
+Because I manage many open source projects, at a certain scale it makes sense to build something to suit your needs
+rather than try to adapt to existing systems. This is one such instance.
 
-My goal is to provide task-centric documentation, and to continually improve the way it's presented. The primary entry point for new developers are the structured usage guides, however having rich cross-referencing into the code is equally important.
+My goal is to provide task-centric documentation, and to continually improve the way it's presented. The primary entry
+point for new developers are the structured usage guides, however having rich cross-referencing into the code is equally
+important.
 
-With that in mind, this web application provides such a model and will evolve over time to suit my requirements and the needs of my users.
+With that in mind, this web application provides such a model and will evolve over time to suit my requirements and the
+needs of my users.
 
 ## Usage
 
-Please see the <a href="https://socketry.github.io/utopia-project/">project documentation</a> or run it locally using `bake utopia:project:serve`.
+Please see the [project documentation](https://socketry.github.io/utopia-project/) for more details.
+
+  - [Getting Started](https://socketry.github.io/utopia-project/guides/getting-started/index) - This guide explains how
+    to use `utopia-project` for your own project.
+
+  - [Documentation Formatting](https://socketry.github.io/utopia-project/guides/documentation-formatting/index) - This
+    guide explains the conventions used by `utopia-project` when generating documentation for your project.
+
+  - [GitHub Pages Integration](https://socketry.github.io/utopia-project/guides/github-pages-integration/index) - This
+    guide shows you how to use `utopia-project` with GitHub Pages.
 
 ## Contributing
 
 We welcome contributions to this project.
 
-1.  Fork it
-2.  Create your feature branch (`git checkout -b my-new-feature`)
-3.  Commit your changes (`git commit -am 'Add some feature'`)
-4.  Push to the branch (`git push origin my-new-feature`)
-5.  Create new Pull Request
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
 
 ## See Also
 
   - [Utopia](https://github.com/socketry/utopia) — The website framework which powers this web application.
   - [Decode](https://github.com/ioquatix/decode) — The source code parser and cross-referencing library.
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2020, by [Samuel G. D. Williams](http://www.codeotaku.com).
-
-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/template/preload.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020, by Samuel Williams.
+# Copyright, 2020-2023, by Samuel Williams.
 
 require 'utopia/project'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.20.3
+  version: 0.22.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -39,7 +39,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-08-27 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decode
@@ -125,20 +125,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
-- !ruby/object:Gem::Dependency
-  name: async-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -182,7 +168,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -202,6 +188,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bake/utopia/project.rb
+- bake/utopia/project/readme/update.rb
+- bake/utopia/project/readme/usage.trenni
 - lib/utopia/project.rb
 - lib/utopia/project/base.md
 - lib/utopia/project/base.rb
@@ -232,13 +220,10 @@ files:
 - pages/source/controller.rb
 - pages/source/index.xnode
 - pages/source/show.xnode
-- public/.DS_Store
 - public/.nojekyll
-- public/_components/.DS_Store
 - public/_components/jquery-litebox/jquery.litebox.css
 - public/_components/jquery-litebox/jquery.litebox.gallery.css
 - public/_components/jquery-litebox/jquery.litebox.js
-- public/_components/jquery-syntax/.DS_Store
 - public/_components/jquery-syntax/base/jquery.syntax.brush.apache.css
 - public/_components/jquery-syntax/base/jquery.syntax.brush.applescript.css
 - public/_components/jquery-syntax/base/jquery.syntax.brush.assembly.css
@@ -309,9 +294,8 @@ files:
 - public/_components/jquery/jquery.slim.js
 - public/_components/jquery/jquery.slim.min.js
 - public/_components/jquery/jquery.slim.min.map
-- public/_components/mermaid/.DS_Store
 - public/_components/mermaid/mermaid.min.js
-- public/_components/mermaid/mermaid.min.js.LICENSE.txt
+- public/_components/mermaid/mermaid.min.js.map
 - public/_static/icon.png
 - public/_static/links.js
 - public/_static/site.css
@@ -340,7 +324,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A project documentation tool based on Utopia.

data/public/_components/mermaid/mermaid.min.js.LICENSE.txt

@@ -1,32 +0,0 @@
-/*!
-   * Wait for document loaded before starting the execution
-   */
-
-/*! @license DOMPurify 2.3.8 | (c) Cure53 and other contributors | Released under the Apache license 2.0 and Mozilla Public License 2.0 | github.com/cure53/DOMPurify/blob/2.3.8/LICENSE */
-
-/*! Check if previously processed */
-
-/*! sequence config was passed as #1 */
-
-/**
- * @license
- * Copyright (c) 2012-2013 Chris Pettitt
- *
- * 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.
- */