forked from cloud-66-internal/help.cloud66.com
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathstyleguide.html
289 lines (236 loc) · 10.2 KB
/
styleguide.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
---
layout: default
title: search for help | Cloud 66
---
<h1 class="article-title">
The Main page heading or h1
</h1>
<p class="lead">
Optional article lead. An overview of the document this could be the tutorial or guide objectives. It's probably not necessary for reference documents.
</p>
<p>This is a normal paragraph style. It could contain some <em>emphasized text</em> or it can contain some <strong>strong</strong> text. Sometimes it may even contain some <span class="highlighted">highlighted</span> text.</p>
<p class="weighted">
This is a weighted paragraph style Lorem ipsum dolor sit amet, consectetur adipisicing elit.
</p>
<p>Text can be highlighted</span> as a block level notice. Notices can be used to draw attention to important blocks of text, be careful not to use this too often on a single page.</p>
<div class="notice">
<h3>A Default Notice</h3>
<p>Call-out some text on the page as important but use sparingly! Lorem ipsum dolor sit amet, consectetur adipisicing elit.</p>
</div>
<div class="notice notice-warning">
<h3>A Warning Notice</h3>
<p>Callout some text on the page as warning but use sparingly! Lorem ipsum dolor sit amet, consectetur adipisicing elit.</p>
</div>
<div class="notice notice-danger">
<h3>A Danger Notice</h3>
<p>Callout some text on the page as dangerous but use VERY sparingly! Lorem ipsum dolor sit amet, consectetur adipisicing elit.</p>
</div>
<p>
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Tempora, quasi, numquam, quidem reprehenderit cupiditate animi dolor ut exercitationem rerum molestias ad inventore accusantium voluptate ex recusandae aliquam sunt officiis iste.
</p>
<h2>A Second level heading or h2</h2>
<p>This is a basic unordered list style. Lorem ipsum dolor sit amet, consectetur adipisicing elit.</p>
<ul>
<li>List item 1</li>
<li>List item 2</li>
<li>List item 3</li>
<li>List item 4</li>
</ul>
<p>List items can contain nested paras:</p>
<ul>
<li>
<p>
<strong>Lorem ipsum</strong> — dolor sit amet, consectetur adipisicing elit. Soluta, eum, dicta reiciendis est aut modi quam provident doloribus magnam molestiae non numquam iure facilis odio harum vero tempore voluptatum accusantium.
</p>
</li>
<li>
<p>
<strong>Soluta eum</strong> — dicta reiciendis est aut modi quam provident doloribus magnam molestiae non numquam iure facilis odio harum
</p>
</li>
</ul>
<p>Need to show keyboard input: <kbd>ssh user@server_address -i /path/to/downloaded/ssh/key/key.pem</kbd>. or instead show a terminal block:</p>
<p>This is a basic ordered list style:</p>
<ol>
<li>This is the first item.</li>
<li>This is the second item.</li>
<li>This is the third item.</li>
</ol>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit.</p>
<pre class="terminal">
<kbd>ssh user@server_address -i /path/to/downloaded/ssh/key/key.pem</kbd>
</pre>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Molestias, omnis, necessitatibus.</p>
<h2>Tabular Data</h2>
<table class='table table-bordered table-striped'>
<thead>
<tr>
<th>Attribute</th>
<th>Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>user</td>
<td>nginx</td>
</tr>
<tr>
<td>worker_processes</td>
<td>Dynamicly set <a href="/help/vendor_instances">based on instance size</a></td>
</tr>
</tbody>
</table>
<!-- TABS EXAMPLE -->
<h2>Tabs Basic Navigation</h2>
<p>A basic example of tabs for navigation. The tab switching is configured by updating the <code>href</code> and <code>id</code> on the related <code>Tabs-content</code> element.</p>
<div class="Tabs">
<nav>
<ul class="TabMini js_tabs">
<li class="TabMini-item active">
<a href="#alpha_content" class="TabMini-link">
Alpha
</a>
</li>
<li class="TabMini-item">
<a href="#beta_content" class="TabMini-link">
Beta
</a>
</li>
<li class="TabMini-item">
<a href="#gamma_content" class="TabMini-link">
Gamma
</a>
</li>
</ul>
</nav>
<section id="alpha_content" class="Tabs-content js_tab_content">
<h4>Alpha</h4>
<p>This is some alpha content. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.</p>
</section>
<section id="beta_content" class="Tabs-content js_tab_content is-hidden">
<h4>Beta</h4>
<p>This is some beta content. Consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et doloreatat non proident, sunt in culpa qui.</p>
</section>
<section id="gamma_content" class="Tabs-content js_tab_content is-hidden">
<h4>Gamma</h4>
<p>This is some gamma content. Amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris.</p>
</section>
</div><!--/.Tabs -->
<!-- /TABS EXAMPLE -->
<h2>Tabs Enclosed Navigation</h2>
<p>An example of Enclosed tabs navigation.</p>
<div class="Tabs Tabs--enclosed">
<nav>
<ul class="TabMini js_tabs">
<li class="TabMini-item active">
<a href="#one_content" class="TabMini-link">
One
</a>
</li>
<li class="TabMini-item">
<a href="#two_content" class="TabMini-link">
Two
</a>
</li>
<li class="TabMini-item">
<a href="#three_content" class="TabMini-link">
Three
</a>
</li>
</ul>
</nav>
<section id="one_content" class="Tabs-content js_tab_content">
<h4>One</h4>
<p>This is some One content. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.</p>
<p>This is some One content. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.</p>
<p>
<a class="Button Button--small Button--app" href="#" target="_blank">Go to Dashboard</a>
</p>
</section>
<section id="two_content" class="Tabs-content js_tab_content is-hidden">
<h4>Two</h4>
<p>This is some Two content. sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.</p>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore.</p>
</section>
<section id="three_content" class="Tabs-content js_tab_content is-hidden">
<h4>Three</h4>
<p>This is some Three content. sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore.</p>
<p>sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip.</p>
</section>
</div><!--/.Tabs -->
<h2>Accordion Navigation</h2>
<div class="accordion">
<h4 class="accordion-toggle active">Accordion 1</h4>
<div class="accordion-content open">
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation.</p>
<p>ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
</div>
<h4 class="accordion-toggle">Accordion 2</h4>
<div class="accordion-content">
<ul>
<li><p>This is a list item accordion. consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.</p></li>
<li><p>Labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco .</p></li>
</ul>
</div>
<h4 class="accordion-toggle">Accordion 3</h4>
<div class="accordion-content">
<ul>
<li><p>This is a list item accordion. consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.</p></li>
<li><p>Labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco .</p></li>
</ul>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
</div>
</div>
<h2>Jekyll Pygments Syntax highlighter</h2>
<p>Jekyll also offers powerful support for code snippets:</p>
<p>Highlight with numbers</p>
{% highlight ruby linenos %}def foo
puts 'foo'
end{% endhighlight %}
<p>Default code highlighter</p>
{% highlight ruby %}
def foo
puts 'foo'
end
{% endhighlight %}
For `bash` highlighting, always use a `$` before the commands entered by the user:
{% highlight bash linenos %}
$ pwd
$ echo
{% endhighlight %}
For values returned by the system use the normal `terminal` class:
<pre class="terminal">
/Users/me/my_awesome_project
</pre>
<h3>Google Code Prettify Syntax Highlighter</h3>
<p>This is a JavaScript alternative to the Jekyll Pygments tool. It may be a better option.</p>
<pre class="prettyprint">var hello = function() {
for (var i = 42; --i >= 0;) {
console.log('hello');
}
// This is a comment with a link <a href="#voila2">tags</a>.
}</pre>