blob: 924859a92c2c06d5eb2a058e8a5c3dde938a8f25 (
plain)
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
|
/*
* SonarQube
* Copyright (C) 2009-2021 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
import * as React from 'react';
export default function FormattingHelp() {
return (
<div className="page page-limited">
<h2 className="spacer-bottom">Formatting Syntax</h2>
<table className="width-100 data zebra">
<thead>
<tr>
<th>Write:</th>
<th>To display:</th>
</tr>
</thead>
<tbody>
<tr>
<td>*this text is bold*</td>
<td className="markdown">
<strong>this text is bold</strong>
</td>
</tr>
<tr>
<td>https://sonarqube.org</td>
<td className="markdown">
<a href="https://sonarqube.org">https://sonarqube.org</a>
</td>
</tr>
<tr>
<td className="text-top">[SonarQube™ Home Page](https://www.sonarqube.org)</td>
<td className="markdown text-top">
<a href="https://www.sonarqube.org">SonarQube™ Home Page</a>
</td>
</tr>
<tr>
<td className="text-top">
* first item
<br />* second item
</td>
<td className="markdown">
<ul>
<li>first item</li>
<li>second item</li>
</ul>
</td>
</tr>
<tr>
<td className="text-top">
1. first item
<br />
1. second item
</td>
<td className="markdown text-top">
<ol>
<li>first item</li>
<li>second item</li>
</ol>
</td>
</tr>
<tr>
<td className="text-top">
= Heading Level 1<br />
== Heading Level 2<br />
=== Heading Level 3<br />
==== Heading Level 4<br />
===== Heading Level 5<br />
====== Heading Level 6<br />
</td>
<td className="markdown text-top">
<h1>Heading Level 1</h1>
<h2>Heading Level 2</h2>
<h3>Heading Level 3</h3>
<h4>Heading Level 4</h4>
<h5>Heading Level 5</h5>
<h6>Heading Level 6</h6>
</td>
</tr>
<tr>
<td className="text-top">``Lists#newArrayList()``</td>
<td className="markdown text-top">
<code>Lists#newArrayList()</code>
</td>
</tr>
<tr>
<td className="text-top">
``
<br />
{'// code on multiple lines'}
<br />
{'public void foo() {'}
<br />
{'// do some logic here'}
<br />
{'}'}
<br />
``
</td>
<td className="markdown text-top">
<pre>
{'// code on multiple lines\npublic void foo() {\n // do some logic here\n}'}
</pre>
</td>
</tr>
<tr>
<td className="text-top">
Standard text
<br />
> Blockquoted text
<br />
> that spans multiple lines
<br />
</td>
<td className="markdown text-top">
<p>Standard text</p>
<blockquote>
Blockquoted text
<br />
that spans multiple lines
<br />
</blockquote>
</td>
</tr>
</tbody>
</table>
</div>
);
}
|
