-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
56 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,26 @@ | ||
## Example | ||
|
||
Inline code examples from the working example in [/doc/example](/doc/example). | ||
Build all tasks (or a main task when defined): | ||
|
||
The build file [mkdoc.js](/doc/example/mkdoc.js): | ||
```shell | ||
mk | ||
``` | ||
|
||
<? @source {javascript} ../example/mkdoc.js ?> | ||
Build specific tasks: | ||
|
||
The input source file [source.md](/doc/example/source.md): | ||
```shell | ||
mk api readme | ||
``` | ||
|
||
<? @source {markdown} ../example/source.md ?> | ||
Use a specific build file: | ||
|
||
Include file [include.md](/doc/example/include.md): | ||
```shell | ||
mk -f ~/mkdoc.js readme | ||
``` | ||
|
||
<? @source {markdown} ../example/include.md ?> | ||
To see a list of tasks use: | ||
|
||
Include file [links.md](/doc/example/links.md): | ||
```shell | ||
mk --tasks | ||
``` | ||
|
||
<? @source {markdown} ../example/links.md ?> | ||
|
||
Result: | ||
|
||
<? @exec {markdown} cd doc/example && mk ?> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
## Sample | ||
|
||
Inline code examples from the working example in [/doc/example](/doc/example). | ||
|
||
The build file [mkdoc.js](/doc/example/mkdoc.js): | ||
|
||
<? @source {javascript} ../example/mkdoc.js ?> | ||
|
||
The input source file [source.md](/doc/example/source.md): | ||
|
||
<? @source {markdown} ../example/source.md ?> | ||
|
||
Include file [include.md](/doc/example/include.md): | ||
|
||
<? @source {markdown} ../example/include.md ?> | ||
|
||
Include file [links.md](/doc/example/links.md): | ||
|
||
<? @source {markdown} ../example/links.md ?> | ||
|
||
Result: | ||
|
||
<? @exec {markdown} cd doc/example && mk ?> |