3rd-party
/
catch2
mirror of https://github.com/catchorg/Catch2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a template for creating new documentation page 

Related to #1695
This commit is contained in:
Martin Hořeňovský 2019-08-02 13:17:22 +02:00
parent 3d7282c2bd
commit de0674c116
No known key found for this signature in database
GPG Key ID: DE48307B8B0D381A
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/contributing.md
View File

@ -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