README.md in jekyll-theme-open-hub-0.1.4 vs README.md in jekyll-theme-open-hub-0.1.5
- old
+ new
@@ -324,17 +324,30 @@
of your open project’s Jekyll site.
Note: even though they’re in different subdirectories, all software products and specs
within one project share URL namespace and hence must have unique names.
+YAML frontmatter that can be used with both software and specs:
+
+```yaml
+title: A Few Words
+# Shown to the user
+# and used for HTML metadata if jekyll-seo-tag is enabled
+
+description: A sentence.
+# Not necessarily shown to the user,
+# but used for HTML metadata if jekyll-seo-tag is enabled
+```
+
### Software product
YAML frontmatter specific to software:
```yaml
version: v1.2.3
docs_url: https://foobar.readthedocs.io/en/latest
+repo_url: https://github.com/…
stack: [Python, Django, AWS]
```
#### Documentation
@@ -361,10 +374,12 @@
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>]
+
+source_url: https://example.com/spec-source-markup
```
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 (##).
@@ -385,14 +400,14 @@
- You can style SVG shapes using in site’s assets/css/style.scss.
## Content guidelines
-- Project title: 1-3 words, capital case
-- Project feature description: about 20-24 words, no markup
-- Project, software, spec regular description: about 12 words, no markup
-- Post title: 3–7 words
-- Post excerpt: about 20–24 words, no markup
+- Project, software, spec title: 1-3 words, capital case
+- Project, software, spec description: about 12 words, no markup
+- Project description (featured): about 20-24 words, no markup
+- Blog post title: 3–7 words
+- Blog post excerpt: about 20–24 words, no markup
## Select layout reference
Normally you don’t need to specify layouts manually, except where