Skip to content

Commit 29dc0ba

Browse files
knollearyknolleary
committed
Overhaul the docs
1 parent 08f4f05 commit 29dc0ba

File tree

213 files changed

+3803
-1702
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

213 files changed

+3803
-1702
lines changed

‎_config.yml

+4-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@ markdown: kramdown
33
permalink: /blog/:year/:month/:day/:title
44
paginate: 9
55
paginate_path: "/blog/page/:num/"
6-
url: http://nodered.org
7-
gems: [jekyll-paginate]
6+
url: https://nodered.org
7+
plugins:
8+
- jekyll-paginate
9+
- jekyll-redirect-from
810
future: true
911
authors:
1012
nick:

‎_includes/breadcrumbs.html

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<div class="breadcrumbs">
2+
<div class="grid">
3+
{% if top_slug %}
4+
<a {% unless parent_slug %}class="active" {% endunless %}href="{{top_url}}">{{top_slug}}</a>
5+
{% else %}
6+
<a {% unless parent_slug %}class="active" {% endunless %}href="/docs">docs</a>
7+
{% endif %}
8+
{% if parent_slug %} &bull; <a {% unless page.slug %}class="active" {% endunless %}href="{{parent_url}}">{{parent_slug}}</a>{% endif %}
9+
{% for slug in page.slug %}&bull; <a {% if forloop.last %}class="active" {% endif %}href="{% if slug.url %}{{slug.url}}{% endif %}">{% if slug.label %}{{slug.label}}{% else %}{{slug}}{% endif %}</a>{% endfor %}
10+
11+
</div>
12+
</div>

‎_includes/docs-content.html

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{% include header.html %}
2+
<div class="docs">
3+
{% include breadcrumbs.html %}
4+
<div class="grid">
5+
{% if page.toc %}
6+
<div id="toc-column" class="col-3-12">
7+
{% include {{ page.toc }} %}
8+
{% include toc-footer.html %}
9+
</div>
10+
<div class="col-9-12">
11+
{% else %}
12+
<div class="col-1-12">&nbsp;</div>
13+
<div class="col-10-12">
14+
{% endif %}
15+
<div class="docs-content">
16+
<h1 class="docs-title">{{ page.title }}</h1>
17+
<div>{{ content }}</div>
18+
</div>
19+
</div>
20+
{% unless page.toc %}
21+
<div class="col-1-12">&nbsp;</div>
22+
{% endunless %}
23+
</div>
24+
</div>
25+
{% include footer.html %}

‎_includes/docs-toc.html

-65
This file was deleted.

‎_includes/getting-started-toc.html

-42
This file was deleted.

‎_includes/header.html

+1-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<title>Node-RED{% if page.title %} : {{ page.title }}{% endif %}</title>
6+
<title>{% if page.title %}{{ page.title }} : {% endif %}Node-RED</title>
77
<link href='https://fonts.googleapis.com/css?family=Roboto+Slab:400,700,300,100' rel='stylesheet' type='text/css'>
88
<link href='https://fonts.googleapis.com/css?family=Ubuntu+Mono' rel='stylesheet' type='text/css'>
99
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,400,700" rel="stylesheet">
@@ -17,7 +17,6 @@
1717
<link href="/css/blog.css" rel="stylesheet" media="screen">
1818
<link href="/css/syntax.css" rel="stylesheet" media="screen">
1919
<link type="application/atom+xml" rel="alternate" href="{{ site.url }}/feed.xml" />
20-
{% if page.url contains "/api/" %}<link href="/css/api.css" rel="stylesheet" media="screen">{% endif %}
2120
{% if page.layout == 'blog' %}<meta name="twitter:card" content="summary" />
2221
<meta name="twitter:site" content="@nodered" />
2322
<meta name="twitter:title" content="{{ page.title | xml_escape }}" />

‎_includes/about-toc.html ‎_includes/toc-about.html

+8
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,11 @@
1111
</ul>
1212
</li>
1313
</ul>
14+
<script>
15+
$(function() {
16+
var pageToc = $("<ul></ul>").appendTo(".toc li.active:not(.toctitle)");
17+
$(".docs-content h3,.docs-content h4").each(function() {
18+
$('<li id="toc-item-'+$(this).attr('id')+'"><a style="font-size: 0.9em; padding-left: 60px;" href="#'+$(this).attr('id')+'">'+$(this).text()+'</a></li>').appendTo(pageToc)
19+
})
20+
})
21+
</script>

‎_includes/toc-api-admin.html

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<ul class="toc">
2+
<li class="toc-expander">V</li>
3+
<li class="tocheader">
4+
<ul>
5+
<li class="{% if page.url == "/docs/api/admin/" %} active{% endif %}"><a href="/docs/api/admin/">Admin HTTP API</a>
6+
<li {% if page.url == "/docs/api/admin/oauth" %}class="active"{% endif %}><a href="/docs/api/admin/oauth">Authentication</a>
7+
<li {% if page.url == "/docs/api/admin/types" %}class="active"{% endif %}><a href="/docs/api/admin/types">Types</a>
8+
<li {% if page.url == "/docs/api/admin/errors" %}class="active"{% endif %}><a href="/docs/api/admin/errors">Errors</a>
9+
<li {% if page.url contains "/docs/api/admin/methods" %}class="active"{% endif %}><a href="/docs/api/admin/methods">Methods</a>
10+
</ul>
11+
</li>
12+
</ul>
13+
<script>
14+
$(function() {
15+
var pageToc = $("<ul></ul>").appendTo(".toc li.active:not(.toctitle)");
16+
$(".docs-content h3,.docs-content h4").each(function() {
17+
$('<li id="toc-item-'+$(this).attr('id')+'"><a style="font-size: 0.9em; padding-left: 60px;" href="#'+$(this).attr('id')+'">'+$(this).text()+'</a></li>').appendTo(pageToc)
18+
})
19+
})
20+
</script>

‎_includes/toc-api-context.html

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<ul class="toc">
2+
<li class="toc-expander">V</li>
3+
<li class="tocheader">
4+
<ul>
5+
<li class="{% if page.url == "/docs/api/context/" %} active{% endif %}"><a href="/docs/api/context/">Context Store API</a>
6+
<li {% if page.url contains "/docs/api/context/methods" %}class="active"{% endif %}><a href="/docs/api/context/methods">Methods</a>
7+
<li {% if page.url contains "/docs/api/context/store/memory" %}class="active"{% endif %}><a href="/docs/api/context/store/memory">Memory store</a>
8+
<li {% if page.url contains "/docs/api/context/store/localfilesystem" %}class="active"{% endif %}><a href="/docs/api/context/store/localfilesystem">File store</a>
9+
</ul>
10+
</li>
11+
</ul>
12+
<script>
13+
$(function() {
14+
var pageToc = $("<ul></ul>").appendTo(".toc li.active:not(.toctitle)");
15+
$(".docs-content h3,.docs-content h4").each(function() {
16+
$('<li id="toc-item-'+$(this).attr('id')+'"><a style="font-size: 0.9em; padding-left: 60px;" href="#'+$(this).attr('id')+'">'+$(this).text()+'</a></li>').appendTo(pageToc)
17+
})
18+
})
19+
</script>

‎_includes/toc-api-modules.html

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<ul class="toc">
2+
<li class="toc-expander">V</li>
3+
<li class="tocheader">
4+
<ul>
5+
<li class="{% if page.url == "/docs/api/modules/" %} active{% endif %}"><a href="/docs/api/modules/">Module APIs</a>
6+
</ul>
7+
</li>
8+
</ul>
9+
<script>
10+
$(function() {
11+
var pageToc = $("<ul></ul>").appendTo(".toc li.active:not(.toctitle)");
12+
$(".docs-content h3,.docs-content h4").each(function() {
13+
$('<li id="toc-item-'+$(this).attr('id')+'"><a style="font-size: 0.9em; padding-left: 60px;" href="#'+$(this).attr('id')+'">'+$(this).text()+'</a></li>').appendTo(pageToc)
14+
})
15+
})
16+
</script>

‎_includes/toc-api-storage.html

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<ul class="toc">
2+
<li class="toc-expander">V</li>
3+
<li class="tocheader">
4+
<ul>
5+
<li class="{% if page.url == "/docs/api/storage/" %} active{% endif %}"><a href="/docs/api/storage/">Storage API</a>
6+
<li {% if page.url contains "/docs/api/storage/methods" %}class="active"{% endif %}><a href="/docs/api/storage/methods">Methods</a>
7+
</ul>
8+
</li>
9+
</ul>
10+
<script>
11+
$(function() {
12+
var pageToc = $("<ul></ul>").appendTo(".toc li.active:not(.toctitle)");
13+
$(".docs-content h3,.docs-content h4").each(function() {
14+
$('<li id="toc-item-'+$(this).attr('id')+'"><a style="font-size: 0.9em; padding-left: 60px;" href="#'+$(this).attr('id')+'">'+$(this).text()+'</a></li>').appendTo(pageToc)
15+
})
16+
})
17+
</script>

‎_includes/toc-api-ui.html

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<ul class="toc">
2+
<li class="toc-expander">V</li>
3+
<li class="tocheader">
4+
<ul>
5+
<li class="{% if page.url == "/docs/api/ui/" %} active{% endif %}"><a href="/docs/api/ui/">Editor Widgets</a>
6+
<li {% if page.url contains "/docs/api/ui/editableList" %}class="active"{% endif %}><a href="/docs/api/ui/editableList">EditableList</a>
7+
<li {% if page.url contains "/docs/api/ui/searchBox" %}class="active"{% endif %}><a href="/docs/api/ui/searchBox">SearchBox</a>
8+
<li {% if page.url contains "/docs/api/ui/treeList" %}class="active"{% endif %}><a href="/docs/api/ui/treeList">TreeList</a>
9+
<li {% if page.url contains "/docs/api/ui/typedInput" %}class="active"{% endif %}><a href="/docs/api/ui/typedInput">TypedInput</a>
10+
</ul>
11+
</li>
12+
</ul>
13+
<script>
14+
<!-- $(function() {
15+
var pageToc = $("<ul></ul>").appendTo(".toc li.active:not(.toctitle)");
16+
$(".docs-content h3,.docs-content h4").each(function() {
17+
$('<li id="toc-item-'+$(this).attr('id')+'"><a style="font-size: 0.9em; padding-left: 60px;" href="#'+$(this).attr('id')+'">'+$(this).text()+'</a></li>').appendTo(pageToc)
18+
})
19+
}) -->
20+
</script>

‎_includes/api-toc.html ‎_includes/toc-api.html

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<ul class="toc">
22
<li class="toc-expander">V</li>
3-
<li><a href="/docs/">&larr; back</a></li>
43
<li class="tocheader">
54
<ul>
65
<li class="toctitle active"><a href="/docs/api/">API Reference</a>

‎_includes/creating-nodes-toc.html ‎_includes/toc-creating-nodes.html

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<ul class="toc">
22
<li class="toc-expander"><div>V</div></li>
3-
<li><a href="/docs/">&larr; back</a></li>
43
<li class="tocheader">
54
<ul>
65
<li class="toctitle active"><a href="/docs/creating-nodes/">Creating Nodes</a></li>
@@ -19,3 +18,11 @@
1918
</ul>
2019
</li>
2120
</ul>
21+
<script>
22+
$(function() {
23+
var pageToc = $("<ul></ul>").appendTo(".toc li.active:not(.toctitle)");
24+
$(".docs-content h3,.docs-content h4").each(function() {
25+
$('<li id="toc-item-'+$(this).attr('id')+'"><a style="font-size: 0.9em; padding-left: 50px;" href="#'+$(this).attr('id')+'">'+$(this).text()+'</a></li>').appendTo(pageToc)
26+
})
27+
})
28+
</script>

‎_includes/developing-toc.html ‎_includes/toc-developing.html

File renamed without changes.

0 commit comments

Comments
 (0)