FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat: use reference links for Markdown output, improving brevity · documentationjs/documentation@ab494dd · GitHub

/ documentation Public

Commit ab494dd

Browse files
tmcw
authored
feat: use reference links for Markdown output, improving brevity
* Use reference links in Markdown. Fixes #948. This approach might be problematic when inserting markdown under a readme heading if the readme already has link references with conflicting ID’s. * Reference links edits: - fix broken normalize() utility in test suite so that it produces output that doesn't choke referenceLinks. - add DocumentationConfig option `--noReferenceLinks` which will be **internal only**, and turns off reference links for `readme` mode - rebuilds test output with these changes unrelated but minor - includes .prettierrc and updates calls to prettier to use that instead of CLI options * chore: update test snapshots * Update readme snap
1 parent 64f660d commit ab494dd

10 files changed

Lines changed: 1005 additions & 582 deletions

File tree

‎.prettierrc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"singleQuote": true
3+
}

‎__tests__/__snapshots__/bin.js.snap‎

Lines changed: 102 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1769,36 +1769,36 @@ exports[`build --document-exported 1`] = `
17691769
17701770
### Table of Contents
17711771
1772-
- [z](#z)
1773-
- [zMethod](#zmethod)
1774-
- [x](#x)
1775-
- [Class](#class)
1776-
- [classMethod](#classmethod)
1777-
- [classGetter](#classgetter)
1778-
- [classSetter](#classsetter)
1779-
- [staticMethod](#staticmethod)
1780-
- [staticGetter](#staticgetter)
1781-
- [staticSetter](#staticsetter)
1782-
- [T5](#t5)
1783-
- [y2Default](#y2default)
1784-
- [y4](#y4)
1785-
- [object](#object)
1786-
- [method](#method)
1787-
- [getter](#getter)
1788-
- [setter](#setter)
1789-
- [prop](#prop)
1790-
- [func](#func)
1791-
- [f1](#f1)
1792-
- [f3](#f3)
1793-
- [T](#t)
1794-
- [T2](#t2)
1795-
- [T4](#t4)
1796-
- [f4](#f4)
1797-
- [o1](#o1)
1798-
- [om1](#om1)
1799-
- [f5](#f5)
1800-
- [o2](#o2)
1801-
- [om2](#om2)
1772+
- [z][1]
1773+
- [zMethod][2]
1774+
- [x][3]
1775+
- [Class][4]
1776+
- [classMethod][5]
1777+
- [classGetter][6]
1778+
- [classSetter][7]
1779+
- [staticMethod][8]
1780+
- [staticGetter][9]
1781+
- [staticSetter][10]
1782+
- [T5][11]
1783+
- [y2Default][12]
1784+
- [y4][13]
1785+
- [object][14]
1786+
- [method][15]
1787+
- [getter][16]
1788+
- [setter][17]
1789+
- [prop][18]
1790+
- [func][19]
1791+
- [f1][20]
1792+
- [f3][21]
1793+
- [T][22]
1794+
- [T2][23]
1795+
- [T4][24]
1796+
- [f4][25]
1797+
- [o1][26]
1798+
- [om1][27]
1799+
- [f5][28]
1800+
- [o2][29]
1801+
- [om2][30]
18021802
18031803
## z
18041804
@@ -1814,7 +1814,7 @@ exports[`build --document-exported 1`] = `
18141814
18151815
**Parameters**
18161816
1817-
- \`a\` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1817+
- \`a\` **[string][31]**
18181818
18191819
### classMethod
18201820
@@ -1838,7 +1838,7 @@ exports[`build --document-exported 1`] = `
18381838
18391839
## T5
18401840
1841-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
1841+
Type: [boolean][32]
18421842
18431843
## y2Default
18441844
@@ -1848,7 +1848,7 @@ Description of y3
18481848
18491849
**Parameters**
18501850
1851-
- \`p\` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
1851+
- \`p\` **[number][33]**
18521852
18531853
Returns **void**
18541854
@@ -1874,15 +1874,15 @@ Returns **void**
18741874
18751875
## T
18761876
1877-
Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
1877+
Type: [number][33]
18781878
18791879
## T2
18801880
1881-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
1881+
Type: [string][31]
18821882
18831883
## T4
18841884
1885-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
1885+
Type: [string][31]
18861886
18871887
## f4
18881888
@@ -1905,6 +1905,72 @@ f5 comment
19051905
## o2
19061906
19071907
### om2
1908+
1909+
[1]: #z
1910+
1911+
[2]: #zmethod
1912+
1913+
[3]: #x
1914+
1915+
[4]: #class
1916+
1917+
[5]: #classmethod
1918+
1919+
[6]: #classgetter
1920+
1921+
[7]: #classsetter
1922+
1923+
[8]: #staticmethod
1924+
1925+
[9]: #staticgetter
1926+
1927+
[10]: #staticsetter
1928+
1929+
[11]: #t5
1930+
1931+
[12]: #y2default
1932+
1933+
[13]: #y4
1934+
1935+
[14]: #object
1936+
1937+
[15]: #method
1938+
1939+
[16]: #getter
1940+
1941+
[17]: #setter
1942+
1943+
[18]: #prop
1944+
1945+
[19]: #func
1946+
1947+
[20]: #f1
1948+
1949+
[21]: #f3
1950+
1951+
[22]: #t
1952+
1953+
[23]: #t2
1954+
1955+
[24]: #t4
1956+
1957+
[25]: #f4
1958+
1959+
[26]: #o1
1960+
1961+
[27]: #om1
1962+
1963+
[28]: #f5
1964+
1965+
[29]: #o2
1966+
1967+
[30]: #om2
1968+
1969+
[31]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
1970+
1971+
[32]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
1972+
1973+
[33]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
19081974
"
19091975
`;
19101976

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL