utopia-project 0.20.2 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/bake/utopia/project.rb +4 -0
- data/lib/utopia/project/base.rb +13 -20
- data/lib/utopia/project/document.rb +10 -19
- data/lib/utopia/project/guide.rb +5 -22
- data/lib/utopia/project/linkify.rb +2 -19
- data/lib/utopia/project/renderer.rb +2 -19
- data/lib/utopia/project/version.rb +3 -20
- data/lib/utopia/project.rb +2 -19
- data/license.md +23 -0
- data/pages/_header.xnode +5 -1
- data/pages/controller.rb +5 -2
- data/pages/guides/controller.rb +4 -0
- data/pages/index.xnode +1 -1
- data/pages/links.yaml +1 -0
- data/pages/source/controller.rb +4 -0
- data/public/_components/jquery/jquery.js +209 -97
- data/public/_components/jquery/jquery.min.js +2 -2
- data/public/_components/jquery/jquery.min.map +1 -1
- data/public/_components/jquery/jquery.slim.js +197 -85
- data/public/_components/jquery/jquery.slim.min.js +2 -2
- data/public/_components/jquery/jquery.slim.min.map +1 -1
- data/public/_components/mermaid/mermaid.min.js +1589 -3
- data/public/_components/mermaid/mermaid.min.js.map +1 -0
- data/readme.md +32 -0
- data/template/preload.rb +4 -0
- data.tar.gz.sig +0 -0
- metadata +34 -44
- metadata.gz.sig +0 -0
- data/public/_components/mermaid/mermaid.min.js.LICENSE.txt +0 -32
data/readme.md
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
# Utopia::Project
|
2
|
+
|
3
|
+
A simple Ruby project documentation website.
|
4
|
+
|
5
|
+
[](https://github.com/socketry/utopia-project/actions?workflow=Test)
|
6
|
+
|
7
|
+
## Motivation
|
8
|
+
|
9
|
+
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.
|
10
|
+
|
11
|
+
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.
|
12
|
+
|
13
|
+
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.
|
14
|
+
|
15
|
+
## Usage
|
16
|
+
|
17
|
+
Please see the <a href="https://socketry.github.io/utopia-project/">project documentation</a> or run it locally using `bake utopia:project:serve`.
|
18
|
+
|
19
|
+
## Contributing
|
20
|
+
|
21
|
+
We welcome contributions to this project.
|
22
|
+
|
23
|
+
1. Fork it.
|
24
|
+
2. Create your feature branch (`git checkout -b my-new-feature`).
|
25
|
+
3. Commit your changes (`git commit -am 'Add some feature'`).
|
26
|
+
4. Push to the branch (`git push origin my-new-feature`).
|
27
|
+
5. Create new Pull Request.
|
28
|
+
|
29
|
+
## See Also
|
30
|
+
|
31
|
+
- [Utopia](https://github.com/socketry/utopia) — The website framework which powers this web application.
|
32
|
+
- [Decode](https://github.com/ioquatix/decode) — The source code parser and cross-referencing library.
|
data/template/preload.rb
CHANGED
data.tar.gz.sig
CHANGED
Binary file
|
metadata
CHANGED
@@ -1,43 +1,45 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: utopia-project
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.21.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Samuel Williams
|
8
8
|
- Olle Jonsson
|
9
|
+
- dependabot[bot]
|
9
10
|
autorequire:
|
10
11
|
bindir: bin
|
11
12
|
cert_chain:
|
12
13
|
- |
|
13
14
|
-----BEGIN CERTIFICATE-----
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
15
|
+
MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
|
16
|
+
ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
|
17
|
+
CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
|
18
|
+
MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
|
19
|
+
MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
|
20
|
+
bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
|
21
|
+
igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
|
22
|
+
9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
|
23
|
+
sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
|
24
|
+
e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
|
25
|
+
XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
|
26
|
+
RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
|
27
|
+
tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
|
28
|
+
zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
|
29
|
+
xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
|
30
|
+
BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
|
31
|
+
aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
|
32
|
+
aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
|
33
|
+
cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
|
34
|
+
xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
|
35
|
+
c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
|
36
|
+
8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
|
37
|
+
JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
|
38
|
+
eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
|
39
|
+
Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
|
40
|
+
voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
|
39
41
|
-----END CERTIFICATE-----
|
40
|
-
date:
|
42
|
+
date: 2023-02-18 00:00:00.000000000 Z
|
41
43
|
dependencies:
|
42
44
|
- !ruby/object:Gem::Dependency
|
43
45
|
name: decode
|
@@ -123,20 +125,6 @@ dependencies:
|
|
123
125
|
- - "~>"
|
124
126
|
- !ruby/object:Gem::Version
|
125
127
|
version: '2.14'
|
126
|
-
- !ruby/object:Gem::Dependency
|
127
|
-
name: async-rspec
|
128
|
-
requirement: !ruby/object:Gem::Requirement
|
129
|
-
requirements:
|
130
|
-
- - ">="
|
131
|
-
- !ruby/object:Gem::Version
|
132
|
-
version: '0'
|
133
|
-
type: :development
|
134
|
-
prerelease: false
|
135
|
-
version_requirements: !ruby/object:Gem::Requirement
|
136
|
-
requirements:
|
137
|
-
- - ">="
|
138
|
-
- !ruby/object:Gem::Version
|
139
|
-
version: '0'
|
140
128
|
- !ruby/object:Gem::Dependency
|
141
129
|
name: bundler
|
142
130
|
requirement: !ruby/object:Gem::Requirement
|
@@ -180,7 +168,7 @@ dependencies:
|
|
180
168
|
- !ruby/object:Gem::Version
|
181
169
|
version: '0'
|
182
170
|
- !ruby/object:Gem::Dependency
|
183
|
-
name:
|
171
|
+
name: sus
|
184
172
|
requirement: !ruby/object:Gem::Requirement
|
185
173
|
requirements:
|
186
174
|
- - ">="
|
@@ -208,6 +196,7 @@ files:
|
|
208
196
|
- lib/utopia/project/linkify.rb
|
209
197
|
- lib/utopia/project/renderer.rb
|
210
198
|
- lib/utopia/project/version.rb
|
199
|
+
- license.md
|
211
200
|
- pages/_header.xnode
|
212
201
|
- pages/_heading.xnode
|
213
202
|
- pages/_navigation.xnode
|
@@ -304,10 +293,11 @@ files:
|
|
304
293
|
- public/_components/jquery/jquery.slim.min.js
|
305
294
|
- public/_components/jquery/jquery.slim.min.map
|
306
295
|
- public/_components/mermaid/mermaid.min.js
|
307
|
-
- public/_components/mermaid/mermaid.min.js.
|
296
|
+
- public/_components/mermaid/mermaid.min.js.map
|
308
297
|
- public/_static/icon.png
|
309
298
|
- public/_static/links.js
|
310
299
|
- public/_static/site.css
|
300
|
+
- readme.md
|
311
301
|
- template/Gemfile
|
312
302
|
- template/config.ru
|
313
303
|
- template/preload.rb
|
@@ -332,7 +322,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
332
322
|
- !ruby/object:Gem::Version
|
333
323
|
version: '0'
|
334
324
|
requirements: []
|
335
|
-
rubygems_version: 3.
|
325
|
+
rubygems_version: 3.4.6
|
336
326
|
signing_key:
|
337
327
|
specification_version: 4
|
338
328
|
summary: A project documentation tool based on Utopia.
|
metadata.gz.sig
CHANGED
Binary file
|
@@ -1,32 +0,0 @@
|
|
1
|
-
/*!
|
2
|
-
* Wait for document loaded before starting the execution
|
3
|
-
*/
|
4
|
-
|
5
|
-
/*! @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 */
|
6
|
-
|
7
|
-
/*! Check if previously processed */
|
8
|
-
|
9
|
-
/*! sequence config was passed as #1 */
|
10
|
-
|
11
|
-
/**
|
12
|
-
* @license
|
13
|
-
* Copyright (c) 2012-2013 Chris Pettitt
|
14
|
-
*
|
15
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
16
|
-
* of this software and associated documentation files (the "Software"), to deal
|
17
|
-
* in the Software without restriction, including without limitation the rights
|
18
|
-
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
19
|
-
* copies of the Software, and to permit persons to whom the Software is
|
20
|
-
* furnished to do so, subject to the following conditions:
|
21
|
-
*
|
22
|
-
* The above copyright notice and this permission notice shall be included in
|
23
|
-
* all copies or substantial portions of the Software.
|
24
|
-
*
|
25
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
26
|
-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
27
|
-
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
28
|
-
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
29
|
-
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
30
|
-
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
31
|
-
* THE SOFTWARE.
|
32
|
-
*/
|