This repository was archived by the owner on Dec 11, 2024. It is now read-only.
File tree Expand file tree Collapse file tree 3 files changed +22
-7
lines changed Expand file tree Collapse file tree 3 files changed +22
-7
lines changed Original file line number Diff line number Diff line change @@ -22,6 +22,7 @@ For the command line interface install [mkdoc][] globally (`npm i -g mkdoc`).
22
22
23
23
- [ Install] ( #install )
24
24
- [ Usage] ( #usage )
25
+ - [ Example] ( #example )
25
26
- [ Help] ( #help )
26
27
- [ API] ( #api )
27
28
- [ abs] ( #abs )
@@ -43,6 +44,20 @@ ast.src('[readme](/README.md)')
43
44
.pipe (process .stdout );
44
45
```
45
46
47
+ ## Example
48
+
49
+ Make links absolute using data in ` package.json ` :
50
+
51
+ ``` shell
52
+ mkcat README.md | mkabs | mkout
53
+ ```
54
+
55
+ Make links absolute using an specific URL:
56
+
57
+ ``` shell
58
+ mkcat README.md | mkabs -b http://example.com | mkout
59
+ ```
60
+
46
61
## Help
47
62
48
63
```
Original file line number Diff line number Diff line change @@ -14,13 +14,7 @@ The typical use case is for README documents whose forward slash links work as e
14
14
<!-- @toc -->
15
15
***
16
16
17
- ## Usage
18
-
19
- Create the stream and write a [ commonmark] [ ] document:
20
-
21
- <? @source {javascript=s/\.\.\/index/mkabs/gm} usage.js ?>
22
-
23
- <? @include {=readme} help.md ?>
17
+ <? @include {=readme} usage.md example.md help.md ?>
24
18
25
19
<? @exec mkapi index.js absolute.js --title=API --level=2 ?>
26
20
<? @include {=readme} license.md links.md ?>
Original file line number Diff line number Diff line change
1
+ ## Usage
2
+
3
+ Create the stream and write a [ commonmark] [ ] document:
4
+
5
+ <? @source {javascript=s/\.\.\/index/mkabs/gm} ../usage.js ?>
6
+
You can’t perform that action at this time.
0 commit comments