added enterprise formatting and shortcode, updated readme with enterprise info
Scott Anderson
parent
f0d45ccd46
commit
1edcb9c00e
33
README.md
33
README.md
|
|
@ -74,6 +74,8 @@ menu:
|
|||
parent: # Specifies a parent group and nests navigation items
|
||||
weight: # Determines sort order.
|
||||
draft: # If true, will not render page on build
|
||||
enterprise_all: # If true, specifies the doc as a whole is specific to InfluxDB Enterprise
|
||||
enterprise_some: # If true, specifies the doc includes some content specific to InfluxDB Enterprise
|
||||
```
|
||||
|
||||
#### Title usage
|
||||
|
|
@ -95,7 +97,7 @@ Use only h2-h6 headings in markdown content.
|
|||
h1 headings act as the page title and are populated automatically from the `title` frontmatter.
|
||||
h2-h6 headings act as section headings.
|
||||
|
||||
### Notes & Warnings
|
||||
### Notes and warnings
|
||||
Shortcodes are available for formatting notes and warnings in each article:
|
||||
|
||||
```md
|
||||
|
|
@ -107,3 +109,32 @@ Insert note markdown content here.
|
|||
Insert warning markdown content here.
|
||||
{{% /warn %}}
|
||||
```
|
||||
|
||||
### Enterprise Content
|
||||
Many articles are unique to InfluxDB enterprise or at least contain some information specific to InfluxDB Enterprise.
|
||||
There are frontmatter and an enterprise shortcode that help to properly identify this content.
|
||||
|
||||
#### All content is Enterprise-specific
|
||||
If all content in an article is Enterprise-specific, set the `enterprise_all` frontmatter to `true`.
|
||||
|
||||
```yaml
|
||||
enterprise_all: true
|
||||
```
|
||||
|
||||
This will display a message at the top of page indicating that the things discussed are unique to InfluxDB Enterprise.
|
||||
|
||||
#### Only some content is Enterprise-specific
|
||||
If only some content in the article is enterprise specific, set the `enterprise_some` frontmatter to `true`.
|
||||
|
||||
```yaml
|
||||
enterprise_some: true
|
||||
```
|
||||
|
||||
This will display a message at the top of page indicating some things are unique to InfluxDB Enterprise.
|
||||
To format Enterprise-specific content, wrap it in the `{{% enterprise %}}` shortcode:
|
||||
|
||||
```md
|
||||
{{% enterprise %}}
|
||||
Insert enterprise-specific markdown content here.
|
||||
{{% /enterprise %}}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -119,7 +119,7 @@
|
|||
margin: .2rem 0;
|
||||
}
|
||||
|
||||
// Code
|
||||
//////////////////////////////////// Code ////////////////////////////////////
|
||||
|
||||
code,pre {
|
||||
background: $article-code-bg;
|
||||
|
|
@ -187,20 +187,22 @@
|
|||
}
|
||||
}
|
||||
|
||||
//////////////////////// Blockquotes, Notes, Warnings ////////////////////////
|
||||
////////////////// Blockquotes, Notes, Warnings, & Messages //////////////////
|
||||
|
||||
blockquote,
|
||||
.note,
|
||||
.warn {
|
||||
.warn,
|
||||
#enterprise-msg {
|
||||
padding: 1.65rem 2rem .1rem 2rem;
|
||||
margin: 1rem 0 2rem;
|
||||
border-width: 0 0 0 4px;
|
||||
border-style: solid
|
||||
border-style: solid;
|
||||
border-radius: 0 $border-radius $border-radius 0;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
border-color: rgba($article-text, .25);
|
||||
p {
|
||||
p, li {
|
||||
font-size: 1.15rem;
|
||||
font-style: italic;
|
||||
color: rgba($article-text, .5);
|
||||
|
|
@ -213,7 +215,7 @@
|
|||
h1,h2,h3,h4,h5,h6 {
|
||||
color: $article-note-heading;
|
||||
}
|
||||
p {
|
||||
p, li {
|
||||
color: $article-note-text;
|
||||
}
|
||||
a {
|
||||
|
|
@ -228,6 +230,9 @@
|
|||
}
|
||||
}
|
||||
}
|
||||
ol li:before {
|
||||
color: $article-note-text;
|
||||
}
|
||||
code, pre{
|
||||
color: $article-note-code;
|
||||
background: $article-note-code-bg;
|
||||
|
|
@ -250,7 +255,7 @@
|
|||
h1,h2,h3,h4,h5,h6 {
|
||||
color: $article-warn-heading;
|
||||
}
|
||||
p {
|
||||
p, li {
|
||||
color: $article-warn-text;
|
||||
}
|
||||
a {
|
||||
|
|
@ -265,6 +270,9 @@
|
|||
}
|
||||
}
|
||||
}
|
||||
ol li:before {
|
||||
color: $article-warn-text;
|
||||
}
|
||||
code, pre{
|
||||
color: $article-warn-code;
|
||||
background: $article-warn-code-bg;
|
||||
|
|
@ -281,4 +289,55 @@
|
|||
}
|
||||
}
|
||||
|
||||
///////////////////////////////// Enterprise /////////////////////////////////
|
||||
#enterprise-msg {
|
||||
border-color: $article-enterprise-base;
|
||||
background: rgba($article-enterprise-base, .15);
|
||||
font-style: italic;
|
||||
display: flex;
|
||||
p {
|
||||
color: $article-enterprise-text;
|
||||
}
|
||||
a {
|
||||
color: $article-enterprise-link;
|
||||
&:hover {
|
||||
color: $article-enterprise-link-hover;
|
||||
}
|
||||
}
|
||||
div:first-child { margin-right: 1.25rem; }
|
||||
}
|
||||
|
||||
.enterprise-flag {
|
||||
padding: .2rem .4rem;
|
||||
background: $article-enterprise-base;
|
||||
font-size: .75rem;
|
||||
font-style: normal;
|
||||
font-weight: bold;
|
||||
color: $g20-white;
|
||||
border-radius: $border-radius;
|
||||
vertical-align: text-bottom;
|
||||
&:before {
|
||||
content: "E";
|
||||
}
|
||||
}
|
||||
|
||||
.enterprise {
|
||||
position: relative;
|
||||
padding: 0 0 .01rem 2rem;
|
||||
margin-left: -2rem;
|
||||
border-left: 2px solid $article-enterprise-base;
|
||||
|
||||
.enterprise-flag {
|
||||
position: absolute;
|
||||
top: -.15rem;
|
||||
left: -.68rem;
|
||||
transform: scale(.8);
|
||||
transition: all .2s;
|
||||
&:hover {
|
||||
transform: scale(1);
|
||||
color: $g20-white;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ $article-table-header-right: $b-sapphire !default;
|
|||
$article-table-shadow: #191a1b !default;
|
||||
$article-table-row-alt: $g2-kevlar !default;
|
||||
|
||||
// Article Notes & Warnings
|
||||
// Article Notes, Warnings, & Messages
|
||||
$article-note-base: $gr-viridian !default;
|
||||
$article-note-heading: $g20-white !default;
|
||||
$article-note-text: $gr-viridian !default;
|
||||
|
|
@ -78,3 +78,8 @@ $article-warn-code-bg: #292024 !default;
|
|||
$article-warn-table-header: $o-dreamsicle !default;
|
||||
$article-warn-table-row-alt: #2b252b !default;
|
||||
$article-warn-table-shadow: #191a1b !default;
|
||||
|
||||
$article-enterprise-base: $p-star !default;
|
||||
$article-enterprise-text: $p-potassium !default;
|
||||
$article-enterprise-link: $p-moonstone !default;
|
||||
$article-enterprise-link-hover: $g20-white !default;
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ $article-note-code: #147572;
|
|||
$article-note-code-bg: #d6f7ec;
|
||||
$article-note-table-header: $gr-viridian;
|
||||
$article-note-table-row-alt: #d6f5e9;
|
||||
$article-note-table-shadow: #8cb7ab !default;
|
||||
$article-note-table-shadow: #8cb7ab;
|
||||
|
||||
$article-warn-base: $o-dreamsicle;
|
||||
$article-warn-heading: $o-fire;
|
||||
|
|
@ -76,4 +76,9 @@ $article-warn-code: #f52f75;
|
|||
$article-warn-code-bg: #ffebeb;
|
||||
$article-warn-table-header: $o-dreamsicle;
|
||||
$article-warn-table-row-alt: #ffe6df;
|
||||
$article-warn-table-shadow: #b98a7d !default;
|
||||
$article-warn-table-shadow: #b98a7d;
|
||||
|
||||
$article-enterprise-base: $p-comet;
|
||||
$article-enterprise-text: $p-star;
|
||||
$article-enterprise-link: $p-star;
|
||||
$article-enterprise-link-hover: $b-ocean;
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ menu:
|
|||
v2_0:
|
||||
name: Example post
|
||||
weight: 1
|
||||
#enterprise_all: true
|
||||
enterprise_some: true
|
||||
---
|
||||
|
||||
This is a paragraph. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc rutrum, metus id scelerisque euismod, erat ante suscipit nibh, ac congue enim risus id est. Etiam tristique nisi et tristique auctor. Morbi eu bibendum erat. Sed ullamcorper, dui id lobortis efficitur, mauris odio pharetra neque, vel tempor odio dolor blandit justo.
|
||||
|
|
@ -14,10 +16,12 @@ This is a paragraph. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nu
|
|||
|
||||
This is a paragraph. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc rutrum, metus id scelerisque euismod, erat ante suscipit nibh, ac congue enim risus id est. Etiam tristique nisi et tristique auctor. Morbi eu bibendum erat. Sed ullamcorper, dui id lobortis efficitur, mauris odio pharetra neque, vel tempor odio dolor blandit justo.
|
||||
|
||||
{{% enterprise %}}
|
||||
### h3 This is a header3
|
||||
This is a paragraph. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc rutrum, metus id scelerisque euismod, erat ante suscipit nibh, ac congue enim risus id est. Etiam tristique nisi et tristique auctor. Morbi eu bibendum erat. Sed ullamcorper, dui id lobortis efficitur, mauris odio pharetra neque, vel tempor odio dolor blandit justo.
|
||||
|
||||
This is a paragraph. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc rutrum, metus id scelerisque euismod, erat ante suscipit nibh, ac congue enim risus id est. Etiam tristique nisi et tristique auctor. Morbi eu bibendum erat. Sed ullamcorper, dui id lobortis efficitur, mauris odio pharetra neque, vel tempor odio dolor blandit justo.
|
||||
{{% /enterprise %}}
|
||||
|
||||
#### h4 This is a header4
|
||||
This is a paragraph. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc rutrum, metus id scelerisque euismod, erat ante suscipit nibh, ac congue enim risus id est. Etiam tristique nisi et tristique auctor. Morbi eu bibendum erat. Sed ullamcorper, dui id lobortis efficitur, mauris odio pharetra neque, vel tempor odio dolor blandit justo.
|
||||
|
|
@ -101,7 +105,7 @@ avg_cpu
|
|||
|> yield()
|
||||
//
|
||||
```
|
||||
|
||||
{{% enterprise %}}
|
||||
###### This is a table
|
||||
| Column 1 | Column 2 | Column 3 | Column 4 |
|
||||
| -------- | -------- | -------- | -------- |
|
||||
|
|
@ -109,6 +113,7 @@ avg_cpu
|
|||
| Row 2.1 | Row 2.2 | Row 2.3 | Row 2.4 |
|
||||
| Row 3.1 | Row 3.2 | Row 3.3 | Row 3.4 |
|
||||
| Row 4.1 | Row 4.2 | Row 4.3 | Row 4.4 |
|
||||
| Row 5.1 | Row 5.2 | Row 5.3 | Row 5.4 |
|
||||
|
||||
###### This is a table with lots of stuff
|
||||
| Column 1 | Column 2 | Column 3 | Column 4 |
|
||||
|
|
@ -137,6 +142,7 @@ Etiam tristique nisi et tristique auctor.
|
|||
{{% note %}}
|
||||
This is a basic note.
|
||||
{{% /note %}}
|
||||
{{% /enterprise %}}
|
||||
|
||||
{{% note %}}
|
||||
## h2 This is a header2
|
||||
|
|
@ -164,6 +170,54 @@ This is an [inline link](#). This is `inline code`.
|
|||
This is an [`inline code link`](#) .
|
||||
This is **bold**. This is _italic_.
|
||||
|
||||
- Unordered list line-item 1
|
||||
- Unordered list line-item 2
|
||||
- Unordered list line-item 2.1
|
||||
- Unordered list line-item 2.2
|
||||
- Unordered list line-item 2.3
|
||||
- Unordered list line-item 3
|
||||
- Unordered list line-item with multiple paragraphs.
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
- Unordered list line-item with multiple paragraphs.
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
1. Unordered list line-item 1
|
||||
2. Unordered list line-item 2
|
||||
1. Unordered list line-item 2.1
|
||||
2. Unordered list line-item 2.2
|
||||
3. Unordered list line-item 2.3
|
||||
3. Unordered list line-item 3
|
||||
4. Unordered list line-item with multiple paragraphs.
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
5. Unordered list line-item with multiple paragraphs.
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
```js
|
||||
// This is a code block inside of a blockquote
|
||||
cpu = from(bucket:"telegraf/autogen")
|
||||
|
|
@ -222,6 +276,54 @@ This is an [inline link](#). This is `inline code`.
|
|||
This is an [`inline code link`](#) .
|
||||
This is **bold**. This is _italic_.
|
||||
|
||||
- Unordered list line-item 1
|
||||
- Unordered list line-item 2
|
||||
- Unordered list line-item 2.1
|
||||
- Unordered list line-item 2.2
|
||||
- Unordered list line-item 2.3
|
||||
- Unordered list line-item 3
|
||||
- Unordered list line-item with multiple paragraphs.
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
- Unordered list line-item with multiple paragraphs.
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
1. Unordered list line-item 1
|
||||
2. Unordered list line-item 2
|
||||
1. Unordered list line-item 2.1
|
||||
2. Unordered list line-item 2.2
|
||||
3. Unordered list line-item 2.3
|
||||
3. Unordered list line-item 3
|
||||
4. Unordered list line-item with multiple paragraphs.
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
5. Unordered list line-item with multiple paragraphs.
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Nunc rutrum, metus id scelerisque euismod, erat ante, ac congue enim risus id est.
|
||||
Etiam tristique nisi et tristique auctor.
|
||||
|
||||
```js
|
||||
// This is a code block inside of a blockquote
|
||||
cpu = from(bucket:"telegraf/autogen")
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
<div class="article">
|
||||
<div class="article--content">
|
||||
<h1>{{ .Title }}</h1>
|
||||
{{ partial "article/enterprise.html" . }}
|
||||
{{ .Content }}
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
<div class="article">
|
||||
<div class="article--content">
|
||||
<h1>{{ .Title }}</h1>
|
||||
{{ partial "article/enterprise.html" . }}
|
||||
{{ .Content }}
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
{{ if ( $.Params.enterprise_all ) }}
|
||||
<div id="enterprise-msg">
|
||||
<p>
|
||||
The features and functionality discussed on this page are unique to the Enterprise edition of InfluxDB.
|
||||
<a href="#">Learn more about InfluxDB Enterprise</a>.
|
||||
</p>
|
||||
</div>
|
||||
{{ else if ( $.Params.enterprise_some ) }}
|
||||
<div id="enterprise-msg">
|
||||
<div>
|
||||
<span class="enterprise-flag"></span>
|
||||
</div>
|
||||
<div>
|
||||
<p>
|
||||
This page includes features and functionality unique to the Enterprise edition of InfluxDB.
|
||||
<a href="#">Learn more about InfluxDB Enterprise</a>.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
{{ end }}
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<div class="enterprise">
|
||||
<a class="enterprise-flag" href="#enterprise-msg"></a>
|
||||
{{ .Inner }}
|
||||
</div>
|
||||
Loading…
Reference in New Issue