utopia-project 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9254ec1335e8bb5b9b4a72277c0c758127db694186b8290253776c2fc55388d
-  data.tar.gz: eb0c13feab735f177d597a0bc73b312b6d44bdac2b95bdcbbc618ab60073784a
+  metadata.gz: 85fc87afd1995b56900a8c667b2c2a114d64a220f02b49323c9b96144b6c9df9
+  data.tar.gz: f1c9502a2078cd29d4aa2b1b39e6194429f488b325975c9814c106fa76bcd528
 SHA512:
-  metadata.gz: f0ab5ee3f504207a4b93d6363b39d6159655d716368cceb3bb3603c7f6159cffbf65cba06965faade1ca28d2616d8dcdf50b96cd9fe4856e01374cacbceacd5a
-  data.tar.gz: 8fd4a5f81cbe6b20fcd0bc4e7a803e891e07cc8931dc4c5310b4b6a7f221d0af070e1262e89bf617f7976b38e6089a4b89a739443935f4dc71468ecbc05d960e
+  metadata.gz: a161d8d671a97d3dc138b80ebfd08a3dff467035268a9f06e3a3240ddfc4f4f58671e2e342d318f7d607286903921d9701af9bc09543743d9e13855dcaf37ac6
+  data.tar.gz: 32227079b3b4f5af305c61c583135005c2b53bb5b0ae24c782c234038b0fb4cff435062b7aca6e25274096a8b4c2b83bc32b01b0e6bdd82c8ede77d8c9588001

data/README.md

@@ -10,6 +10,14 @@ My goal is to provide task-centric documentation, and to continually improve the
 
 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.
 
+## Installation
+
+Execute the following in your project:
+
+~~~ bash
+bundle add utopia-project
+~~~
+
 ## Usage
 
 Please see the <a href="https://socketry.github.io/utopia-project/">project documentation</a> or run it locally using `bake utopia:project:serve`.

data/lib/utopia/project.rb

@@ -62,8 +62,8 @@ module Utopia
 				builder.use Rack::ShowExceptions unless UTOPIA.testing?
 			end
 			
-			public_root = File.expand_path("public", root)
-			builder.use Utopia::Static, root: public_root
+			# We serve static files from the project root:
+			builder.use Utopia::Static, root: root
 			
 			builder.use Utopia::Static, root: PUBLIC_ROOT
 			

data/lib/utopia/project/version.rb

@@ -22,6 +22,6 @@
 
 module Utopia
 	module Project
-		VERSION = "0.2.1"
+		VERSION = "0.3.0"
 	end
 end

data/pages/controller.rb

@@ -7,10 +7,6 @@ on 'index' do
 	if readme_path = @base.path_for('README.md')
 		@document = Kramdown::Document.new(File.read(readme_path), syntax_highlighter: nil)
 		
-		if title = @document.root.children.shift
-			@title = title.children.first.value
-		end
-		
 		start = @document.root.children.index{|node| node.children.first&.value == "Usage"}
 		finish = start + 1
 		

data/pages/guides/index.xnode

@@ -9,7 +9,7 @@
 		<?r
 		base = controller[:base]
 		
-		base.guides do |guides|
+		base.guides do |guide|
 			?><li><a href="#{guide.name}/">#{guide.title}</a></li><?r
 		end
 		?></ul>

data/pages/index.xnode

@@ -1,9 +1,31 @@
 <content:page>
-	<content:heading>#{self[:title] || "Project"}</content:heading>
-	
-	<?r if document = self[:document] ?>
-	#{MarkupString.raw document.to_html}
-	<?r else ?>
-	<p>This project does not have a README.md file.</p>
-	<?r end ?>
+	<?r
+	if document = self[:document]
+		children = document.root.children
+		
+		if children.first.type == :header
+			header = children.shift
+			title = header.children.first
+			case title.type
+			when :text
+				?><content:heading>#{title.value}</content:heading><?r
+			when :img
+				self.document.attributes[:title] ||= title.attr["alt"]
+				?><header><img src="#{title.attr["src"]}" /></header><?r
+			else
+				?><content:heading>Project</content:heading><?r
+			end
+		else
+			?><content:heading>Project</content:heading><?r
+		end
+		
+		?>#{MarkupString.raw document.to_html}<?r
+	else
+		?>
+		<content:heading>Project</content:heading>
+		
+		<p>This project does not have a README.md file.</p>
+		<?r
+	end
+	?>
 </content:page>

data/public/_static/site.css

@@ -75,7 +75,7 @@ body {
 	margin: 0 auto;
 }
 
-h1, h2, h3, h4, h5, h6, p, ul, dl, ol {
+header, h1, h2, h3, h4, h5, h6, p, ul, dl, ol {
 	margin: 1rem;
 }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams