README.md in jekyll-theme-open-hub-0.1.3 vs README.md in jekyll-theme-open-hub-0.1.4
- old
+ new
@@ -94,19 +94,19 @@
```yaml
title: Site title
description: Site description
# The above two are used by jekyll-seo-tag for things such as
# `<title>` and `<meta>` tags, as well as elsewhere by the theme.
-
+
collections:
posts:
output: true
permalink: /blog/:month-:day-:year/:title/
pages:
output: true
permalink: /:name/
-
+
defaults:
- scope:
path: ""
values:
layout: default
@@ -204,11 +204,11 @@
### Project, spec and software data
See the section about project data structure.
-In addition to that, _when used within hub site_ each project subdirectory
+_When used within hub site_ (only), each project subdirectory
must contain a file "index.md" with frontmatter like this:
```yaml
title: Sample Awesome Project
@@ -269,30 +269,30 @@
email: your-email@example.com
author: "Company or Individual Name Goes Here"
collections:
+ # ... (other collections)
software:
output: true
permalink: /:name/
specs:
output: true
permalink: /:name/
- # ... (other collections)
defaults:
+ # ... (other defaults)
- scope:
path: _software
type: software
values:
layout: product
- scope:
path: _specs
type: specs
values:
layout: spec
- # ... (other defaults)
```
File layout is the same as described in the section
about shared project data structure, with _software and _specs directories
found in the root of your Jekyll site.
@@ -354,9 +354,16 @@
YAML frontmatter specific to specs:
```yaml
rfc_id: XXXX
+# IETF RFC URL would be in the form
+# http://ietf.org/html/rfc<id>
+
+ietf_datatracker_id: some-string-identifier-here
+ietf_datatracker_ver: "01"
+# IETF datatracker URL would be in the form
+# https://datatracker.ietf.org/doc/<id>[-<version>]
```
Specs that are not hosted elsewhere (such as ietf.org for RFCs)
are expected to contain the actual specification content after frontmatter.
Start with second-level header (##).