utopia-project 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85fc87afd1995b56900a8c667b2c2a114d64a220f02b49323c9b96144b6c9df9
-  data.tar.gz: f1c9502a2078cd29d4aa2b1b39e6194429f488b325975c9814c106fa76bcd528
+  metadata.gz: eef5d39417b6da1e11cd8aeff16e645dbf6b1c0ae48ea93179b25410cecc69f4
+  data.tar.gz: 1bf148454089d81f4273d7eb22984bd8893ea6298be2db2d154e0723dffd0152
 SHA512:
-  metadata.gz: a161d8d671a97d3dc138b80ebfd08a3dff467035268a9f06e3a3240ddfc4f4f58671e2e342d318f7d607286903921d9701af9bc09543743d9e13855dcaf37ac6
-  data.tar.gz: 32227079b3b4f5af305c61c583135005c2b53bb5b0ae24c782c234038b0fb4cff435062b7aca6e25274096a8b4c2b83bc32b01b0e6bdd82c8ede77d8c9588001
+  metadata.gz: 9ddc7844454bcc5b7b0c311e2c4e56a17a3d8609502c115fc24ec27a2153824f0cb08080c4825a9271270ad2aff945ed40448674f0b66848e250c076f84050a3
+  data.tar.gz: 4b2ed3f8b72cdab39c7a5dd9e75b62a7c1a2b47c56bfde0057881e2041b4ed10ff732bd8e71acf74df70b276e76e037cb4d61e67518e7c8d0902ee448fefc0d2

data/guides/getting-started/README.md

@@ -0,0 +1,31 @@
+# Getting Started
+
+This guide explains how to use `utopia-project` for your own project.
+
+## Installation
+
+Firstly, add the gem to your project:
+
+~~~ bash
+$ bundle add utopia-project
+~~~
+
+## Start Local Server
+
+Start the local server to preview documentation:
+
+~~~ bash
+$ bake utopia:project:serve
+~~~
+
+Right now, this server does not reload the code index, so you will need to restart the server to update the code index. This will be fixed in the future.
+
+## Generate Static Site
+
+You can generate a static copy of your documentation into the `docs/` folder:
+
+~~~ bash
+$ bake utopia:project:static
+~~~
+
+You can check the [guide for GitHub Pages](../github-pages-integration/index) which gives more details on how to deploy the static site using GitHub.

data/guides/links.yaml

@@ -0,0 +1,6 @@
+getting-started:
+  order: 1
+documentation-formatting:
+  order: 2
+github-pages-integration:
+  order: 3

data/lib/utopia/project/base.rb

@@ -21,6 +21,8 @@
 # THE SOFTWARE.
 
 require 'utopia/path'
+require 'utopia/content/links'
+
 require 'trenni/reference'
 require 'decode'
 
@@ -56,6 +58,8 @@ module Utopia
 				@source_path = Utopia::Path["/source"]
 				
 				@index = Decode::Index.new
+				
+				@links = Utopia::Content::Links.new(@root)
 			end
 			
 			# The file-system path to the root of the project.
@@ -150,15 +154,10 @@ module Utopia
 			end
 			
 			def guides
-				guides_root = File.expand_path("guides", @root)
-				
-				# There are no guides if there is no directory:
-				return unless File.directory?(guides_root)
-				
 				return to_enum(:guides) unless block_given?
 				
-				Dir.each_child(guides_root) do |entry|
-					guide_path = File.join(guides_root, entry)
+				@links.index("/guides").each do |link|
+					guide_path = File.join(@root, link.path)
 					
 					next unless File.directory?(guide_path)
 					

data/lib/utopia/project/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -194,7 +194,9 @@ files:
 - bake/utopia/project.rb
 - gems.rb
 - guides/documentation-formatting/README.md
+- guides/getting-started/README.md
 - guides/github-pages-integration/README.md
+- guides/links.yaml
 - lib/utopia/project.rb
 - lib/utopia/project/base.rb
 - lib/utopia/project/guide.rb