utopia-project 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (9) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +13 -0
  3. data/lib/utopia/project/base.rb +1 -1
  4. data/lib/utopia/project/guide.rb +1 -0
  5. data/lib/utopia/project/version.rb +1 -1
  6. data/pages/_page.xnode +2 -0
  7. data/pages/source/index.xnode +1 -1
  8. data/public/_static/site.css +2 -55
  9. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6aa72e7117031702241752a366174d7bc8fa7a44ca0bbf52de399ef9c89173e4
4
- data.tar.gz: b32f8ef78c132cfcb4cd414416aa0c7dd547e9253a989565f3446027003b55ef
3
+ metadata.gz: d079c534edadc8369f297c530d544cece5c97b38d024e7aaf47a0fa8a2773d38
4
+ data.tar.gz: 4c85546bb35c5c72050241ab1ed2067f3c43e9ac8a2da243dbe06866dcdb785c
5
5
  SHA512:
6
- metadata.gz: 582d3f3051f7f0a304b4bf1c286eb22fc45bc9b8a87ef3cb5f51740553608cbef88a4d1d0db5cb442acc1d101884f4eb020e34e47c4fc466b47ca4bb312b7b9a
7
- data.tar.gz: 264853fea075ef9d3f1b1787a3b9bd3c6f42364bb29378efbbbb6f9e501eb366655f4df26fbf740b74c02ff58e96560d21ae444909afb3e52eeb186929ba3879
6
+ metadata.gz: 85e9bcab3e4b773701589a3fad01032bcfd5ec627d94dd0f3562d622ed27826b1235215038d3a339a7ba2a02f7b0e0ca74f7ef3f2bb7c8cc7e38b2941a0807bd
7
+ data.tar.gz: 2e3bf584b57cb29f3d11a68a794e6db7e351ea463ad4bc60a8ce8b945006e54cfe6f00cc2eeb1586add8d8df4c0d7e6a552332b2ad11758cb71e49d1c8cee350
data/README.md CHANGED
@@ -2,6 +2,14 @@
2
2
 
3
3
  A simple Ruby project documentation website.
4
4
 
5
+ ## Motivation
6
+
7
+ 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.
8
+
9
+ 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.
10
+
11
+ 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.
12
+
5
13
  ## Usage
6
14
 
7
15
  Please see the <a href="https://socketry.github.io/utopia-project/">project documentation</a> or run it locally using `bake utopia:project:serve`.
@@ -16,6 +24,11 @@ We welcome contributions to this project.
16
24
  4. Push to the branch (`git push origin my-new-feature`)
17
25
  5. Create new Pull Request
18
26
 
27
+ ## See Also
28
+
29
+ - [Utopia](https://github.com/socketry/utopia) — The website framework which powers this documentation application.
30
+ - [Decode](https://github.com/ioquatix/decode) — The source code parser and cross-referencing library.
31
+
19
32
  ## License
20
33
 
21
34
  Released under the MIT license.
data/lib/utopia/project/base.rb CHANGED
@@ -32,7 +32,7 @@ require_relative 'guide'
32
32
 
33
33
  module Utopia
34
34
  module Project
35
- # The base symbol table and project index.
35
+ # Provides structured access to a project directory which contains source code and guides.
36
36
  class Base
37
37
  extend Thread::Local
38
38
 
data/lib/utopia/project/guide.rb CHANGED
@@ -27,6 +27,7 @@ require 'kramdown'
27
27
 
28
28
  module Utopia
29
29
  module Project
30
+ # Provides structured access to a directory which contains documentation and source code to explain a specific process.
30
31
  class Guide
31
32
  # Initialize the example with the given root path.
32
33
  # @param base [Base] The base instance for the project.
data/lib/utopia/project/version.rb CHANGED
@@ -22,6 +22,6 @@
22
22
 
23
23
  module Utopia
24
24
  module Project
25
- VERSION = "0.1.0"
25
+ VERSION = "0.2.0"
26
26
  end
27
27
  end
data/pages/_page.xnode CHANGED
@@ -28,5 +28,7 @@
28
28
 
29
29
  <body class="#{attributes[:class]}">
30
30
  <utopia:content/>
31
+
32
+ <footer>Documentation generated by <a href="https://github.com/socketry/utopia-project">Utopia::Project</a>.</footer>
31
33
  </body>
32
34
  </html>
data/pages/source/index.xnode CHANGED
@@ -7,7 +7,7 @@
7
7
  index = base.index
8
8
 
9
9
  index.trie.traverse do |path, node, descend|
10
- ?><ul><?r
10
+ ?><ul class="index"><?r
11
11
  if symbols = node.values
12
12
  symbol = base.best(symbols)
13
13
 
data/public/_static/site.css CHANGED
@@ -89,7 +89,7 @@ li {
89
89
  margin: 0.8rem;
90
90
  }
91
91
 
92
- ul {
92
+ ul.index {
93
93
  padding: 0;
94
94
  padding-left: 0.5rem;
95
95
  margin: 0.5rem;
@@ -97,11 +97,6 @@ ul {
97
97
  list-style: none;
98
98
  }
99
99
 
100
- lli:before {
101
- content: "›";
102
- margin-right: 0.4rem;
103
- }
104
-
105
100
  li > ul, li > ol {
106
101
  margin: 0;
107
102
  }
@@ -145,53 +140,5 @@ footer {
145
140
  font-size: 0.65rem;
146
141
 
147
142
  margin: 1rem;
148
- }
149
-
150
- /* Editor */
151
-
152
- .editor form {
153
- position: absolute;
154
-
155
- display: flex;
156
- flex-direction: column;
157
- align-items: center;
158
-
159
- width: 100%;
160
- height: 100%;
161
- }
162
-
163
- .editor .header {
164
- flex-grow: 0;
165
- width: 100%;
166
-
167
- display: flex;
168
- justify-content: space-between;
169
- align-items: center;
170
-
171
- z-index: 10;
172
-
173
- border-bottom: 0.2rem solid var(--accent-color);
174
- background-color: var(--header-color);
175
- }
176
-
177
- .editor .header * {
178
- margin: 0.5rem;
179
- }
180
-
181
- .editor textarea {
182
- flex-grow: 1;
183
- width: 100%;
184
-
185
- resize: none;
186
- outline: none;
187
-
188
- box-sizing: border-box;
189
- margin: 0; padding: 0.5rem;
190
-
191
- border: none;
192
- background: none;
193
- }
194
-
195
- textarea {
196
- color: var(--main-color);
143
+ margin-top: 5rem;
197
144
  }
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: utopia-project
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Samuel Williams