remarkjs / Remark Usage
Programming Languages
Labels
Projects that are alternatives of or similar to Remark Usage
remark-usage
remark plugin to add a usage example to a readme.
Install
npm:
npm install remark-usage
Use
This section is rendered by this module from
example.js. Turtles all the way down. 🐢🐢🐢
Say we are making a module that exports just enough Pi (3.14159).
We’re documenting it with a readme file, example/readme.md:
# PI
More than enough 🍰
## Usage
## License
MIT
…and an example script to document it example/example.js:
// Load dependencies:
var pi = require('.')
// Logging `pi` yields:
console.log('txt', pi)
…If we use remark-usage, we can generate the Usage section
var path = require('path')
var vfile = require('to-vfile')
var remark = require('remark')
var usage = require('remark-usage')
var file = vfile.readSync({path: 'readme.md', cwd: 'example'})
var file = await remark().use(usage).process(file)
Now, printing file (the newly generated readme) yields:
# PI
More than enough 🍰
## Usage
Load dependencies:
```javascript
var pi = require('pi')
```
Logging `pi` yields:
```txt
3.14159
```
## License
MIT
API
remark().use(usage[, options])
Add example.js to the Usage section in a readme.
Removes the current content between the heading containing the text “usage”, and the next heading of the same (or higher) depth, and replaces it with the example.
The example is run in Node.
Line comments are parsed as Markdown.
Calls to console.log() are exposed as code blocks, containing the logged
values (optionally with a language flag).
It’s easiest to check out and compare example.js with the above
Usage section.
- Operate this from an npm package
- Make sure no side effects occur when running
example.js
You can ignore lines like so:
// remark-usage-ignore-next
var two = sum(1, 1)
// remark-usage-ignore-next 3
function sum(a, b) {
return a + b
}
…if no skip is given, 1 line is skipped.
options
options.heading
Heading to look for (string?, default: 'usage').
Wrapped in new RegExp('^(' + value + ')$', 'i');.
options.example
Path to the example script (string?).
If given, resolved from file.cwd.
If not given, the following values are attempted and resolved from file.cwd:
'./example', './examples', './doc/example', './docs/example'.
The first that exists, is used.
options.name
Name of the module (string?, default: pkg.name, optional).
Used to rewrite require('.') to require('name').
options.main
Path to the main file (string?, default: pkg.main or '.', optional).
If given, resolved from file.cwd.
If inferred from package.json, resolved relating to that package root.
Used to rewrite require('.') to require('name').
options.experimentalModules
Pass --experimental-modules when running the example
in Node.
This lets you use ECMAScript Modules if the current version of Node does support
this flag, but does not support ES modules natively.
Security
Use of remark-usage is unsafe because main and example are executed.
This could become dangerous if an attacker was able to inject code into those
files or their dependencies.
Contribute
See contributing.md in remarkjs/.github for ways
to get started.
See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.