Skip to content

Commit

Permalink
Add a template for creating new documentation page
Browse files Browse the repository at this point in the history
Related to #1695
  • Loading branch information
horenmar committed Aug 2, 2019
1 parent 3d7282c commit de0674c
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,19 @@ tags for other features).
e.g. list
* Crosslinks to different pages should target the `top` anchor, like this
`[link to contributing](contributing.md#top)`.
* If you have introduced a new document, please add a a `top` anchor at
the top, like this
* If you have introduced a new document, there is a simple template you
should use. It provides you with the top anchor mentioned above, and also
with a backlink to the top of the documentation:
```markdown
<a id="top"></a>
# Contributing to Catch
# Cool feature

Text that explains how to use the cool feature.


---

[Home](Readme.md#top)
```
* For pages with more than 4 subheadings, we provide a table of contents
(ToC) at the top of the page. Because GitHub markdown does not support
Expand Down

0 comments on commit de0674c

Please sign in to comment.