/
GitHubMarkdown.d.ts
60 lines (56 loc) · 1.28 KB
/
GitHubMarkdown.d.ts
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
/**
* # GitHubMarkdown
*
* Drafts includes Discount-based, GitHub flavored Markdown parser based on [GHMarkdownParser](https://github.com/OliverLetterer/GHMarkdownParser). For details on the meaning of the various options, refer to [Markdown documentation](https://getdrafts.com/settings/markdown).
*
* ### Example
*
* ```javascript
* var inputString = "# Header\n\nMy **markdown** text";
* var md = GitHubMarkdown.create();
*
* var outputString = md.render(inputString);
* ```
*/
declare class GitHubMarkdown {
/**
* Takes Markdown string passed and processes it with GitHub Markdown parser based on the property selections on the object.
*/
render(markdownStr: string): string
/**
* defaults to true
*/
smartQuotesEnabled: boolean
/**
* defaults to true
*/
noImages: boolean
/**
* defaults to true
*/
noLinks: boolean
/**
* defaults to true
*/
safeLinks: boolean
/**
* defaults to false
*/
autoLinks: boolean
/**
* defaults to false
*/
strict: boolean
/**
* defaults to false
*/
removeHTMLTags: boolean
/**
* create a new object.
*/
static create(): GitHubMarkdown
/**
* Create new instance.
*/
constructor()
}