Skip to content

Commit

Permalink
docs: update 'sidebar_label' description
Browse files Browse the repository at this point in the history
  • Loading branch information
maxaggedon committed Nov 22, 2018
1 parent 413e0dc commit fcbf1b3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/api-doc-markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Documents use the following markdown header fields that are enclosed by a line `

`hide_title`: Whether to hide the title at the top of the doc.

`sidebar_label`: The text shown in the document sidebar for this document. If this field is not present, the document's `sidebar_label` will default to its `title`.
`sidebar_label`: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's `sidebar_label` will default to its `title`.

For example:

Expand Down

0 comments on commit fcbf1b3

Please sign in to comment.