utopia-project 0.20.0 → 0.20.3
Sign up to get free protection for your applications and to get access to all the features.
- 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 +14 -21
- 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 +19 -2
- 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 +7 -3
- data/pages/source/show.xnode +30 -23
- data/public/.DS_Store +0 -0
- data/public/_components/.DS_Store +0 -0
- data/public/_components/jquery/jquery.js +118 -109
- 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 +106 -101
- data/public/_components/jquery/jquery.slim.min.js +2 -2
- data/public/_components/jquery/jquery.slim.min.map +1 -1
- data/public/_components/jquery-syntax/.DS_Store +0 -0
- data/public/_components/mermaid/.DS_Store +0 -0
- data/public/_components/mermaid/mermaid.min.js +1 -1
- data/public/_components/mermaid/mermaid.min.js.LICENSE.txt +1 -1
- data/readme.md +56 -0
- data/template/preload.rb +4 -0
- data.tar.gz.sig +0 -0
- metadata +35 -27
- metadata.gz.sig +0 -0
@@ -2,7 +2,7 @@
|
|
2
2
|
* Wait for document loaded before starting the execution
|
3
3
|
*/
|
4
4
|
|
5
|
-
/*! @license DOMPurify 2.3.
|
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
6
|
|
7
7
|
/*! Check if previously processed */
|
8
8
|
|
data/readme.md
ADDED
@@ -0,0 +1,56 @@
|
|
1
|
+
# Utopia::Project
|
2
|
+
|
3
|
+
A simple Ruby project documentation website.
|
4
|
+
|
5
|
+
[![Development Status](https://github.com/socketry/utopia-project/workflows/Test/badge.svg)](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.
|
33
|
+
|
34
|
+
## License
|
35
|
+
|
36
|
+
Released under the MIT license.
|
37
|
+
|
38
|
+
Copyright, 2020, by [Samuel G. D. Williams](http://www.codeotaku.com).
|
39
|
+
|
40
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
41
|
+
of this software and associated documentation files (the "Software"), to deal
|
42
|
+
in the Software without restriction, including without limitation the rights
|
43
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
44
|
+
copies of the Software, and to permit persons to whom the Software is
|
45
|
+
furnished to do so, subject to the following conditions:
|
46
|
+
|
47
|
+
The above copyright notice and this permission notice shall be included in
|
48
|
+
all copies or substantial portions of the Software.
|
49
|
+
|
50
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
51
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
52
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
53
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
54
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
55
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
56
|
+
THE SOFTWARE.
|
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.20.
|
4
|
+
version: 0.20.3
|
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: 2022-
|
42
|
+
date: 2022-08-27 00:00:00.000000000 Z
|
41
43
|
dependencies:
|
42
44
|
- !ruby/object:Gem::Dependency
|
43
45
|
name: decode
|
@@ -208,6 +210,7 @@ files:
|
|
208
210
|
- lib/utopia/project/linkify.rb
|
209
211
|
- lib/utopia/project/renderer.rb
|
210
212
|
- lib/utopia/project/version.rb
|
213
|
+
- license.md
|
211
214
|
- pages/_header.xnode
|
212
215
|
- pages/_heading.xnode
|
213
216
|
- pages/_navigation.xnode
|
@@ -229,10 +232,13 @@ files:
|
|
229
232
|
- pages/source/controller.rb
|
230
233
|
- pages/source/index.xnode
|
231
234
|
- pages/source/show.xnode
|
235
|
+
- public/.DS_Store
|
232
236
|
- public/.nojekyll
|
237
|
+
- public/_components/.DS_Store
|
233
238
|
- public/_components/jquery-litebox/jquery.litebox.css
|
234
239
|
- public/_components/jquery-litebox/jquery.litebox.gallery.css
|
235
240
|
- public/_components/jquery-litebox/jquery.litebox.js
|
241
|
+
- public/_components/jquery-syntax/.DS_Store
|
236
242
|
- public/_components/jquery-syntax/base/jquery.syntax.brush.apache.css
|
237
243
|
- public/_components/jquery-syntax/base/jquery.syntax.brush.applescript.css
|
238
244
|
- public/_components/jquery-syntax/base/jquery.syntax.brush.assembly.css
|
@@ -303,11 +309,13 @@ files:
|
|
303
309
|
- public/_components/jquery/jquery.slim.js
|
304
310
|
- public/_components/jquery/jquery.slim.min.js
|
305
311
|
- public/_components/jquery/jquery.slim.min.map
|
312
|
+
- public/_components/mermaid/.DS_Store
|
306
313
|
- public/_components/mermaid/mermaid.min.js
|
307
314
|
- public/_components/mermaid/mermaid.min.js.LICENSE.txt
|
308
315
|
- public/_static/icon.png
|
309
316
|
- public/_static/links.js
|
310
317
|
- public/_static/site.css
|
318
|
+
- readme.md
|
311
319
|
- template/Gemfile
|
312
320
|
- template/config.ru
|
313
321
|
- template/preload.rb
|
metadata.gz.sig
CHANGED
Binary file
|