Skip to content

Commit

Permalink
docs(contributing and hub-init) correct hub headings (#1011)
Browse files Browse the repository at this point in the history
* docs(contributing) remove heading limitation

* docs(contributing) clarify heading levels example and default logo

* docs(hub-init) correct heading levels

* docs(hub-init) punctuation
  • Loading branch information
coopr committed Oct 31, 2018
1 parent ea58418 commit 743a167
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 11 deletions.
19 changes: 11 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,8 @@ documenting a Kong plugin, be sure to see the next section.
1. If you have a custom logo, add a square-format PNG file to
`/app/_assets/images/icons/hub/` - the filename of your image should be
`publisher_extension` using the "publisher" and "extension" name from step 2.
Custom logos are optional.
Custom logos are optional. If you don't have a custom logo, please duplicate
an existing default logo file, and rename it as noted above.
1. Be sure to run the docs site locally per the instructions in
the README - you should find your Hub contribution listed at
`localhost:3000/hub`
Expand Down Expand Up @@ -358,18 +359,20 @@ portion of the doc site files. If a page has an incorrectly-formatted ToC, be
sure to check:

- Heading levels must be correctly nested. Thus, heading levels like this:

```
# Heading
## Sub-heading
#### Sub-sub-sub-heading
# Heading Level 1
## Sub-heading Level 2
#### Sub-sub-sub-heading Level 4
```

will cause a broken ToC, and should be corrected to:

```
# Heading
## Sub-heading
### Sub-sub-heading
# Heading Level 1
## Sub-heading Level 2
### Sub-sub-heading Level 3
```
- Heading levels 5 and beyond are not supported - see https://github.com/Kong/docs.konghq.com/issues/942

### Contributor T-shirt

Expand Down
10 changes: 7 additions & 3 deletions app/_hub/_init/my-extension/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ description: #|
# (Optional) Link to your online TOS.

# COMPATIBILITY
# In the following sections, list Kong versions as array items
# In the following sections, list Kong versions as array items.
# Versions are categorized by Kong edition and their known compatibility.
# Unlisted Kong versions will be considered to have "unknown" compatibility.
# Uncomment at least one of 'community_edition' or 'enterprise_edition'.
Expand Down Expand Up @@ -170,8 +170,12 @@ params: # metadata about your plugin
#
# The remainder of this file is for free-form description, instruction, and
# reference matter.
# Your headers must be Level 3 or 4 (parsing to h3 or h4 tags in HTML).
# This is represented by ### or #### notation preceding the header text.
# If you include headers, your headers MUST start at Level 2 (parsing to
# h2 tag in HTML). Heading Level 2 is represented by ## notation
# preceding the header text. Subsequent headings,
# if you choose to use them, must be properly nested (eg. heading level 2 may
# be followed by another heading level 2, or by heading level 3, but must NOT be
# followed by heading level 4)
###############################################################################
# BEGIN MARKDOWN CONTENT
---
Expand Down

0 comments on commit 743a167

Please sign in to comment.