Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit caa5f54

Browse files
committed
Update markdown documentation for hackers
1 parent 4c90f85 commit caa5f54

23 files changed

+54
-25
lines changed

docs/hackers/images/markdown-0.png

-747 Bytes
Binary file not shown.

docs/hackers/images/markdown-1.png

-50.5 KB
Loading

docs/hackers/images/markdown-2.png

7.02 KB
Loading

docs/hackers/images/markdown-3.png

-374 KB
Binary file not shown.

docs/hackers/images/markdown-4.png

81.7 KB
Loading

docs/hackers/images/markdown-5.png

13.5 KB
Loading
49.5 KB
Loading
17.4 KB
Loading
17.1 KB
Loading
Loading
21.3 KB
Loading

docs/hackers/images/markdown-code.png

16.1 KB
Loading
-4.69 KB
Loading
Loading
15.5 KB
Loading
15.5 KB
Loading
18.8 KB
Loading
18.1 KB
Loading
19.5 KB
Loading
16.5 KB
Loading
Loading
17.7 KB
Loading

docs/hackers/using-markdown.md

Lines changed: 54 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ Markdown Input:
5656
*This text is italicized*
5757
_This text is underlined_
5858
**This text is bold**
59-
__This text is bold__
6059
~~This text is deleted~~
6160
==This text is highlighted==
6261
```
@@ -107,6 +106,14 @@ Markdown Input:
107106
3. Blue
108107
```
109108

109+
and this:
110+
111+
```
112+
1. Red
113+
1. Green
114+
1. Blue
115+
```
116+
110117
Output:
111118

112119
![ordered list](./images/markdown-numbered-list.png)
@@ -138,12 +145,6 @@ Output:
138145

139146
![link](./images/markdown-link-3.png)
140147

141-
Optionally, you may include a title attribute in the parentheses. Hover on the link to see the title:
142-
```
143-
This is an [example link](http://example.com/ "With a Title").
144-
```
145-
This is an [example link](http://example.com/ "With a Title").
146-
147148
Reference-style links allow you to refer to your links by names, which you define elsewhere in your document:
148149

149150
Markdown Input:
@@ -152,16 +153,16 @@ Markdown Input:
152153
I get 10 times more traffic from [Google][1] than from
153154
[Yahoo][2] or [MSN][3].
154155
155-
[1]: http://google.com/ "Google"
156-
[2]: http://search.yahoo.com/ "Yahoo Search"
157-
[3]: http://search.msn.com/ "MSN Search"
156+
[1]: http://google.com/
157+
[2]: http://search.yahoo.com/
158+
[3]: http://search.msn.com/
158159
```
159160

160161
Output:
161162

162163
![multiple links](./images/markdown-links-2.png)
163164

164-
The title attribute is optional. Link names may contain letters, numbers and spaces, but are not case sensitive:
165+
Link names may contain letters, numbers and spaces, but are not case sensitive:
165166

166167
Markdown Input:
167168

@@ -176,6 +177,26 @@ Output:
176177

177178
![ny times link](./images/markdown-links.png)
178179

180+
<br>
181+
182+
Links to section headings can be made as well. Every heading will get an ID based on the heading content, and prefixed with `user-content-`. A link can be made to a heading using the following markdown:
183+
184+
```
185+
# Table of contents
186+
* [Introduction](#user-content-introduction)
187+
* [Another section](#user-content-another-section)
188+
* [Credits](#user-content-credits)
189+
190+
# Introduction
191+
Text would go here.
192+
193+
# Another section
194+
Some more text would go here.
195+
196+
# Credits
197+
And the credits would go here.
198+
```
199+
179200
#### Email Links
180201
You don't need to use markdown to create a `mailto:` link. Simply enter the email as is and it will automatically be converted to a `mailto:` link.
181202

@@ -207,24 +228,19 @@ To use syntax highlighting, specify the content type after the three opening bac
207228

208229
Markdown Input:
209230

210-
```
211-
```javascript
212-
document.location = 'https://hackerone.com';
213-
```
231+
![markdown code syntax](./images/markdown-code-syntax-input.png)
214232

215233
Output:
216234

217235
![markdown code syntax](./images/markdown-code-syntax.png)
218236

219-
Go to the following web page to see which content types are available for syntax highlighting: https://github.com/jneen/rouge/tree/master/lib/rouge/demos.
220-
221237
### User mentions
222238
You can mention a user by prefixing username with '@' symbol
223239

224240
Markdown Input:
225241

226242
```
227-
@demo-member reported the issue
243+
@demo-member reported the issue.
228244
```
229245

230246
Output:
@@ -238,9 +254,26 @@ Output:
238254

239255
You can reference a report by prefixing report id with '#' symbol
240256
```
241-
#105887 is a publicly disclosed bug
257+
#105887 is a publicly disclosed bug.
258+
```
259+
260+
Output:
261+
262+
![markdown report reference](./images/markdown-report-reference.png)
263+
264+
<br>
265+
266+
### Auto-linked references
267+
268+
CVE IDs, CWE IDs, and CAPEC IDs are automatically linked to MITRE:
269+
270+
```
271+
CVE-2011-0242 could perhaps be categorized as CWE-79 of CAPEC-63.
242272
```
243-
[#105887](https://hackerone.com/reports/105887) is a publicly disclosed bug
273+
274+
Output:
275+
276+
![autolinking references to MITRE](./images/markdown-auto-link-mitre.png)
244277

245278
### Attachment references
246279

@@ -252,18 +285,14 @@ Example: Consider a user is creating a report and uploads an attachment. Once th
252285
Now you can reference the attachment in the report by writing 'F1' and the attachment is referenced in the report as shown below.
253286
![markdown-2](./images/markdown-2.png)
254287

255-
When the link is clicked, the attachment is displayed in the modal.
256-
![markdown-3](./images/markdown-3.png)
257-
258288
### Inline images and video
259289

260290
You can inline images and videos in the report description, comments and report summary by writing the attachment reference id within curly braces (as in {F:id}).
261291

262292
Example: For the above attachment, the markdown:
263293

264-
265294
```
266-
Here is an inlined image of an apple {F1}
295+
{F1}
267296
```
268297

269298
will render the following:

0 commit comments

Comments
 (0)