utopia-project 0.11.2 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a6eb04fb1a45e27cedfe5b735cf063fe37f571a1d78a06c63a74ff8457d8d78
-  data.tar.gz: 214094fb6097b3246f2b449e97f0c8256bb474c96af3a04ff30df1191d7bf6b2
+  metadata.gz: 77139b780df1db585888cdc74792e30c1321cc30f7bd5c2326c483cc615a775e
+  data.tar.gz: 9cce22250274ac1fd13c8083925c9ef5d4d19d39d037c9cba0697071f59f0eec
 SHA512:
-  metadata.gz: 972d6fa18553a40f1740978e4cdfe23265d8e76648383097072f77a2a3ae1b236db748f35003e2bf6bc88c95db4b9f6c2092527be660e3cd44d9508d3d68f450
-  data.tar.gz: 0bf9971c843e0c59273fd4e30f9bcacbe4590fbf971bc299a67eef78d9b02f3fdbcc06a3dd8b10c218ea1457520d61f01d11c1d658ee266ccb7e3568a133cffb
+  metadata.gz: 323bce955baba604915a47db006ea29916a019a0e3ebcf94d026e7a05574cce37fbd989ca3f4679d9a1ff9d14020d71188174b91bc07bc350fa1b11a01dbcb66
+  data.tar.gz: bb09d35ba6ae4cea234b34db4f3ee3401bd77275037cf4bc2cd35cca95da753d2af588e7e139520425c54f5644225b4b98e6c191934aab7c762bb62d256a48c0

data/lib/utopia/project/document.rb

@@ -107,7 +107,7 @@ module Utopia
 				return node
 			end
 			
-			def code_node(content, language)
+			def code_node(content, language = nil)
 				if language
 					node = inline_html_node(
 						"<code class=\"language-#{language}\">#{Trenni::Strings.to_html(content)}</code>"

data/lib/utopia/project/linkify.rb

@@ -41,8 +41,8 @@ module Utopia
 			
 			def link_to(definition, text)
 				Trenni::Builder.fragment do |builder|
-					builder.inline('a', href: @base.link_for(definition)) do
-						builder.text(definition.qualified_name)
+					builder.inline('a', href: @base.link_for(definition), title: definition.qualified_name) do
+						builder.text(text)
 					end
 				end
 			end

data/lib/utopia/project/version.rb

@@ -22,6 +22,6 @@
 
 module Utopia
 	module Project
-		VERSION = "0.11.2"
+		VERSION = "0.13.1"
 	end
 end

data/pages/_header.xnode

@@ -0,0 +1,23 @@
+<header><label for="toggle">☰</label> <?r
+	page_path = first.node.uri_path.dirname
+	
+	Utopia::Path[page_path].descend do |path|
+		unless path.last
+			path = path + "index"
+		end
+		
+		if link = links(path.dirname, name: path.last, locale: localization.current_locale, indices: true).first
+			?> &rsaquo; #{link.to_href}<?r
+		else
+			?> &rsaquo; <span>#{path.last}</span><?r
+		end
+	end
+	
+	if localization.localized?
+		?> &bull; (<?r
+		localization.all_locales.each.with_index do |locale, index|
+			?>#{index.zero? ? '' : ' '}<a href="#{localization.localized_path(page_path, locale)}">#{locale}</a><?r
+		end
+		?>)<?r
+	end
+?></header>

data/pages/_navigation.xnode

@@ -1,23 +1,19 @@
-<nav><?r
-	page_path = first.node.uri_path
+<nav>
+	<template id="search-result">
+		<li>
+			<a href="link">Title</a>
+			<div class="preview">Overview</div>
+		</li>
+	</template>
 	
-	Utopia::Path[page_path.dirname].descend do |path|
-		unless path.last
-			path = path + "index"
-		end
+	<section style="margin: 1rem;">
+		<input type="search" id="search-input" tabindex="0" placeholder="Search..." aria-label="Search..." autocomplete="off" style="width: 100%;"/>
 		
-		if link = links(path.dirname, name: path.last, locale: localization.current_locale, indices: true).first
-			?> &rsaquo; #{link.to_href}<?r
-		else
-			?> &rsaquo; <span>#{path.last}</span><?r
-		end
-	end
-	
-	if localization.localized?
-		?> &bull; (<?r
-		localization.all_locales.each.with_index do |locale, index|
-			?>#{index.zero? ? '' : ' '}<a href="#{localization.localized_path(page_path, locale)}">#{locale}</a><?r
-		end
-		?>)<?r
-	end
-?></nav>
+		<ul id="search-results" class="search-results">
+			<li>
+				<a href="link">Title</a>
+				<div class="preview">Overview</div>
+			</li>
+		</ul>
+	</section>
+</nav>

data/pages/_page.xnode

@@ -18,6 +18,9 @@
 		<script src="/_components/jquery/jquery.min.js"></script>
 		<script src="/_components/jquery-syntax/jquery.syntax.min.js"></script>
 		
+		<script src="/_components/lunr/lunr.min.js"></script>
+		<script src="/_static/links.js"></script>
+		
 		<script type="text/javascript">
 		//<![CDATA[
 			jQuery(function($) {
@@ -27,11 +30,13 @@
 		</script>
 	</head>
 
-	<body class="#{attributes[:class]}">
-		<content:navigation />
-		
-		<utopia:content/>
+	<body>
+		<content:header />
 		
-		<footer>Documentation generated by <a href="https://github.com/socketry/utopia-project">Utopia::Project</a>.</footer>
+		<main>
+			<utopia:content/>
+				
+			<footer>Documentation generated by <a href="https://github.com/socketry/utopia-project">Utopia::Project</a>.</footer>
+		</main>
 	</body>
 </html>

data/pages/guides/index.xnode

@@ -4,14 +4,13 @@
 	?>
 	<content:heading>Guides</content:heading>
 	
-	<main>
-		<ul>
+	<ul>
 		<?r
 		base = controller[:base]
 		
 		base.guides do |guide|
 			?><li><a href="#{guide.name}/">#{guide.title}</a></li><?r
 		end
-		?></ul>
-	</main>
+		?>
+	</ul>
 </content:page>

data/pages/guides/show.xnode

@@ -5,9 +5,9 @@
 	?>
 	<content:heading>#{guide.title}</content:heading>
 	
-	<main><?r
+	<?r
 		if document = guide.document
-			?>#{MarkupString.raw document.to_html}<?r
+			?>#{document.to_html}<?r
 		end
 		
 		guide.sources.each do |source|
@@ -20,5 +20,5 @@
 				?><pre><code class="language-#{source.language.name}">#{segment.code}</code></pre><?r
 			end
 		end
-	?></main>
+	?>
 </content:page>

data/pages/index.xnode

@@ -20,12 +20,12 @@
 			?><content:heading>Project</content:heading><?r
 		end
 		
-		?><main>#{MarkupString.raw document.to_html}</main><?r
+		?>#{MarkupString.raw document.to_html}<?r
 	else
 		?>
 		<content:heading>Project</content:heading>
 		
-		<main><p>This project does not have a README.md file.</p></main>
+		<p>This project does not have a README.md file.</p>
 		<?r
 	end
 	?>

data/pages/source/index.xnode

@@ -1,36 +1,34 @@
 <content:page>
 	<content:heading>Source</content:heading>
 	
-	<main>
-		<?r
-		base = controller[:base]
-		index = base.index
-		
-		index.trie.traverse do |path, node, descend|
-			if symbols = node.values
-				symbol = base.best(symbols)
-				
-				if documentation = symbol.documentation or symbol.container?
-					?><li>
-						<a href="#{base.link_for(symbol)}"><code class="language-#{symbol.language.name}">#{symbol.long_form}</code></a>
-						
-						<?r if documentation and text = documentation.text ?>
-							#{base.format(text.first, symbol)}
-						<?r end ?>
-						
-						<?r if symbol.container?
-							?><ul class="index"><?r
-							descend.call
-							?></ul><?r
-						end ?>
-					</li><?r
-				end
-			else
-				?><ul class="index"><?r
-				descend.call
-				?></ul><?r
+	<?r
+	base = controller[:base]
+	index = base.index
+	
+	index.trie.traverse do |path, node, descend|
+		if symbols = node.values
+			symbol = base.best(symbols)
+			
+			if documentation = symbol.documentation or symbol.container?
+				?><li>
+					<a href="#{base.link_for(symbol)}"><code class="language-#{symbol.language.name}">#{symbol.long_form}</code></a>
+					
+					<?r if documentation and text = documentation.text ?>
+						#{base.format(text.first, symbol)}
+					<?r end ?>
+					
+					<?r if symbol.container?
+						?><ul class="index"><?r
+						descend.call
+						?></ul><?r
+					end ?>
+				</li><?r
 			end
+		else
+			?><ul class="index"><?r
+			descend.call
+			?></ul><?r
 		end
-		?>
-	</main>
+	end
+	?>
 </content:page>

data/pages/source/show.xnode

@@ -6,51 +6,54 @@
 	?>
 	<content:heading><code class="language-#{symbol.language.name}">#{symbol.qualified_name}</code></content:heading>
 	
-	<main>
-		<?r
-		if documentation = symbol.documentation
-			?>#{base.format(documentation.text.join("\n"), symbol)}<?r
-		end
-		?>
-		
-		<?r
-		nested = node.children.map{|name, child| base.best(child.values)}.select{|symbol| symbol.container?}
-		
-		if nested.any?
-		?>
-		<h2>Nested</h2>
-		
-		<ul>
-			<?r nested.each do |symbol| ?>
-			<li><a href="#{base.link_for(symbol)}"><code class="language-#{symbol.language.name}">#{symbol.qualified_name}</code></a></li>
-			<?r end ?>
-		</ul>
-		<?r
-		end
-		?>
-		
-		<h2>Definitions</h2>
-		
-		<?r
-		node.children.each do |name, child|
-			child.values.each do |symbol|
-				if symbol.documentation and !symbol.container?
-					?><h3 id="#{base.id_for(symbol)}"><code class="language-#{symbol.language.name}">#{symbol.long_form}</code></h3><?r
-					
-					if documentation = symbol.documentation
-						?>#{base.format(documentation.text, symbol)}<?r
-						?>#{partial 'content:signature', symbol: symbol}<?r
-					end
-					
-					if symbol.multiline?
-					?><details>
-							<summary><h4>Implementation</h4></summary>
-							<pre><code class="language-#{symbol.language.name}">#{symbol.text}</code></pre>
-						</details><?r
-					end
+	<?r
+	if documentation = symbol.documentation
+		?>#{base.format(documentation.text.join("\n"), symbol)}<?r
+	end
+	?>
+	
+	<?r
+	nested = node.children.map{|name, child| base.best(child.values)}.select{|symbol| symbol.container?}
+	
+	if nested.any?
+	?>
+	<section>
+	<h2>Nested</h2>
+	
+	<ul>
+		<?r nested.each do |symbol| ?>
+		<li><a href="#{base.link_for(symbol)}"><code class="language-#{symbol.language.name}">#{symbol.qualified_name}</code></a></li>
+		<?r end ?>
+	</ul>
+	</section>
+	<?r
+	end
+	?>
+	
+	<section>
+	<h2>Definitions</h2>
+	
+	<?r
+	node.children.each do |name, child|
+		child.values.each do |symbol|
+			if symbol.documentation and !symbol.container?
+				?><section id="#{base.id_for(symbol)}"><h3><code class="language-#{symbol.language.name}">#{symbol.long_form}</code></h3><?r
+				
+				if documentation = symbol.documentation
+					?>#{base.format(documentation.text, symbol)}<?r
+					?>#{partial 'content:signature', symbol: symbol}<?r
 				end
+				
+				if symbol.multiline?
+				?><details>
+						<summary><h4>Implementation</h4></summary>
+						<pre><code class="language-#{symbol.language.name}">#{symbol.text}</code></pre>
+					</details><?r
+				end
+				?></section><?r
 			end
 		end
-		?>
-	</main>
+	end
+	?>
+	</section>
 </content:page>

data/public/_components/jquery-syntax/jquery.syntax.core.js

@@ -9,8 +9,8 @@ Syntax.lib.camelCaseType={pattern:/\b_*[A-Z][\w]*\b/g,klass:"type"};Syntax.lib.c
 Syntax.lib.doubleQuotedString={pattern:/"([^\\"\n]|\\.)*"/g,klass:"string"};Syntax.lib.singleQuotedString={pattern:/'([^\\'\n]|\\.)*'/g,klass:"string"};Syntax.lib.multiLineDoubleQuotedString={pattern:/"([^\\"]|\\.)*"/g,klass:"string"};Syntax.lib.multiLineSingleQuotedString={pattern:/'([^\\']|\\.)*'/g,klass:"string"};Syntax.lib.stringEscape={pattern:/\\./g,klass:"escape",only:["string"]};
 Syntax.Match=function(b,a,c,d){this.offset=b;this.endOffset=b+a;this.length=a;this.expression=c;this.value=d;this.children=[];this.next=this.parent=null};Syntax.Match.prototype.shift=function(b,a){this.adjust(b,null,a);for(var c=0;c<this.children.length;c++)this.children[c].shift(b,a)};Syntax.Match.prototype.adjust=function(b,a,c){this.offset+=b;this.endOffset+=b;a&&(this.length=a,this.endOffset=this.offset+a);c&&(this.value=c.substr(this.offset,this.length))};
 Syntax.Match.sort=function(b,a){return b.offset-a.offset||a.length-b.length};Syntax.Match.prototype.contains=function(b){return b.offset>=this.offset&&b.endOffset<=this.endOffset};Syntax.Match.defaultReduceCallback=function(b,a){"string"===typeof b&&(b=document.createTextNode(b));a.appendChild(b)};
-Syntax.Match.prototype.reduce=function(b,a){var c=this.offset;var d=this.expression&&this.expression.element?this.expression.element.cloneNode(!1):document.createElement("span");b=b||Syntax.Match.defaultReduceCallback;this.expression&&this.expression.klass&&(0<d.className.length&&(d.className+=" "),d.className+=this.expression.klass);this.className&&(d.className+=" ",d.className+=this.className);for(var e=0;e<this.children.length;e+=1){var f=this.children[e],g=f.offset;f.offset<this.offset&&console.log("Syntax Warning: Offset of child",
-f,"is before offset of parent",this);c=this.value.substr(c-this.offset,g-c);b(c,d);b(f.reduce(b,a),d);c=f.endOffset}c===this.offset?b(this.value,d):c<this.endOffset?b(this.value.substr(c-this.offset,this.endOffset-c),d):c>this.endOffset&&console.log("Syntax Warning: Start position "+c+" exceeds end of value "+this.endOffset);a&&(d=a(d,this));return d};
+Syntax.Match.prototype.reduce=function(b,a){var c=this.offset,d=document.createElement("span");b=b||Syntax.Match.defaultReduceCallback;this.expression&&this.expression.klass&&(0<d.className.length&&(d.className+=" "),d.className+=this.expression.klass);this.className&&(d.className+=" ",d.className+=this.className);for(var e=0;e<this.children.length;e+=1){var f=this.children[e],g=f.offset;f.offset<this.offset&&console.log("Syntax Warning: Offset of child",f,"is before offset of parent",this);c=this.value.substr(c-
+this.offset,g-c);b(c,d);b(f.reduce(b,a),d);c=f.endOffset}c===this.offset?b(this.value,d):c<this.endOffset?b(this.value.substr(c-this.offset,this.endOffset-c),d):c>this.endOffset&&console.log("Syntax Warning: Start position "+c+" exceeds end of value "+this.endOffset);a&&(d=a(d,this));return d};
 Syntax.Match.prototype.canContain=function(b){return b.expression.force?!0:this.complete?!1:b.expression.only?!0:"undefined"===typeof this.expression.allow||jQuery.isArray(this.expression.disallow)&&-1!==jQuery.inArray(b.expression.klass,this.expression.disallow)?!1:"*"===this.expression.allow||jQuery.isArray(this.expression.allow)&&-1!==jQuery.inArray(b.expression.klass,this.expression.allow)?!0:!1};
 Syntax.Match.prototype.canHaveChild=function(b){if(b=b.expression.only){for(var a=this;null!==a;){if(-1!==jQuery.inArray(a.expression.klass,b))return!0;if((a=a.parent)&&a.complete)break}return!1}return!0};Syntax.Match.prototype._splice=function(b,a){return this.canHaveChild(a)?(this.children.splice(b,0,a),a.parent=this,a.expression.owner||(a.expression.owner=this.expression.owner),this):null};
 Syntax.Match.prototype.insert=function(b,a){if(!this.contains(b))return null;if(a){a=this;for(var c=0;c<a.children.length;)a.children[c].contains(b)?(a=a.children[c],c=0):c+=1;return a._insertWhole(b)}return this._insert(b)};

data/public/_static/links.js

@@ -0,0 +1,21 @@
+jQuery(function() {
+	$.each($('section[id]'), function(index, element) {
+		let anchor = document.createElement('a');
+		
+		anchor.appendChild(
+			document.createTextNode("¶")
+		);
+		
+		anchor.title = element.innerText;
+		anchor.href = "#" + element.id;
+		anchor.className = "self";
+		
+		let heading = element.firstChild;
+		
+		heading.appendChild(
+			document.createTextNode(' ')
+		);
+		
+		heading.appendChild(anchor);
+	});
+});

data/public/_static/site.css

@@ -33,6 +33,10 @@ p code:first-child, p code:last-child {
 	padding: 0;
 }
 
+p img {
+	max-width: 100%;
+}
+
 pre {
 	/* -moz-tab-size is still required by Firefox */
 	--tab-size: 2;
@@ -80,17 +84,54 @@ html {
 body {
 	margin: 0;
 	padding: 0;
+}
+
+header {
+	padding: 0.5rem;
+	
+	background-color: var(--header-color);
+	border-bottom: 0.2rem solid var(--accent-color);
+}
+
+main {
+	scroll-margin-top: 2rem;
 	
 	/* Force the element to contain margins */
 	display: flow-root;
-	min-height: 100vh;
-		
-	max-width: 48rem;
+	
 	margin: 0 auto;
+	max-width: 48rem;
+}
+
+:target {
+	background-color: var(--header-color);
+}
+
+section {
+	border-radius: 1rem;
+	padding: 0.1rem 0;
+}
+
+main > section {
+	border-radius: 1rem;
+	margin: 4rem 0;
+}
+
+section > section {
+	margin: 1rem 0;
+}
+
+footer {
+	text-align: right;
+	font-size: 0.8rem;
+	
+	padding: 1rem;
+	margin-top: 5rem;
 }
 
-header, h1, h2, h3, h4, h5, h6, p, pre, ul, dl, ol {
+h1, h2, h3, h4, h5, h6, p, pre, ul, dl, ol {
 	margin: 1rem;
+	border-radius: 0.5rem;
 }
 
 h1 span {
@@ -101,12 +142,6 @@ header img {
 	max-height: 50vh;
 }
 
-nav {
-	margin: 1rem;
-	font-size: 0.8rem;
-	color: #aaa;
-}
-
 li, dt, dd {
 	margin: 0.5rem 0;
 }
@@ -129,18 +164,6 @@ h1 {
 	margin-bottom: 4rem;
 }
 
-h2 {
-	margin-top: 6rem;
-}
-
-h3 {
-	margin-top: 4rem;
-}
-
-h4, h5, h6 {
-	margin-top: 2rem;
-}
-
 img {
 	border: none;
 }
@@ -150,6 +173,14 @@ a {
 	text-decoration: none;
 }
 
+a.self {
+	visibility: hidden;
+}
+
+*:hover > a.self {
+	visibility: visible;
+}
+
 a:hover {
 	color: var(--accent-hover-color);
 }
@@ -158,14 +189,6 @@ pre {
 	overflow: auto;
 }
 
-footer {
-	text-align: right;
-	font-size: 0.8rem;
-	
-	margin: 1rem;
-	margin-top: 5rem;
-}
-
 details {
 	margin: 1rem;
 	border: 1px solid #aaa;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.13.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: utopia
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: decode
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,7 @@ files:
 - lib/utopia/project/guide.rb
 - lib/utopia/project/linkify.rb
 - lib/utopia/project/version.rb
+- pages/_header.xnode
 - pages/_heading.xnode
 - pages/_navigation.xnode
 - pages/_page.xnode
@@ -284,6 +285,7 @@ files:
 - public/_components/jquery/jquery.slim.min.js
 - public/_components/jquery/jquery.slim.min.map
 - public/_static/icon.png
+- public/_static/links.js
 - public/_static/site.css
 - template/Gemfile
 - template/config.ru