Styling for links in labels, update README for API labels

This commit is contained in:
aetter 2021-07-28 12:30:34 -07:00
parent 0ac341523a
commit db86114248
2 changed files with 31 additions and 1 deletions

View File

@ -225,7 +225,7 @@ This documentation uses a modified version of the [just-the-docs](https://github
## Get started
New
{: .label .label-green :}
{: .label .label-green }
```
* Labels come in default (blue), green, purple, yellow, and red.
@ -238,6 +238,27 @@ These classes can help with readability, but should be used *sparingly*. Each ad
Besides, standard Markdown elements suffice for most documentation.
## Labels for APIs
Each API operation has a label indicating when it was introduced. For most operations, this label is 1.0:
```
## Get roles
Introduced 1.0
{: .label .label-purple }
```
If we introduce a breaking change to an operation, add an additional label with a link to the release note for that breaking change:
```
## Get roles
Introduced 1.0
{: .label .label-purple }
[Last breaking change 2.0](https://example.com)
{: .label .label-red }
```
## Math
If you want to use the sorts of pretty formulas that [MathJax](https://www.mathjax.org) allows, add `has_math: true` to the Jekyll page metadata. Then insert LaTeX math into HTML tags with the rest of your Markdown content:

View File

@ -214,6 +214,15 @@ h6 + p.label, h6 + p.label + p.label {
margin: -20px 0 0 0;
}
p.label {
a {
color: inherit;
background-image: none;
&:hover { background-image: none; }
}
}
// Modifies margins in xl layout to support TOC
.side-bar {
@include mq(xl) {