Skip to content

Commit abb6a4f

Browse files
Merge pull request #841 from ossf/spp_hints
Add SPP hints
2 parents f8bd072 + 3f96cf7 commit abb6a4f

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/spp/Simplest-Possible-Process.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ When using markdown:
9292
Each heading name should be unique (so the generated ids are unique).
9393
You can reference any heading via its ID, e.g., `[text](#ID)`.
9494
Here is the [algorithm for determining header IDs](https://kramdown.gettalong.org/converter/html.html).
95+
* If you don't want certain headings to be auto-numbered, after the heading
96+
line add a line saying `{:.nocount}` to make the heading part of that class.
97+
To suppress TOC entries append the line `{:.no_toc}` after that heading.
9598
* If you want a table-of-contents, use `:toc` surrounded by curly braces
9699
on its own line.
97100
* By default, [GitHub Pages](https://pages.github.com/) uses the
@@ -168,6 +171,11 @@ Here's how to do that:
168171
This is already configured to comply with the
169172
[OpenSSF Brand Guidelines](https://openssf.org/about/brand-guidelines/)
170173
such as our preferred fonts and color scheme.
174+
5. Add an `index.md` file inside the `docs/` directory with at least
175+
a little content (possibly linking to important materials).
176+
Without this file (or similar `index.html`), viewing the top-level
177+
domain will present the confusing and technically incorrect error
178+
page saying "There isn't a GitHub Pages site here."
171179

172180
## Rationale for the SPP
173181

0 commit comments

Comments
 (0)