@textlint/website-generator
v0.17.0
Published
Website generator using @textlint/script-compiler
Downloads
158
Readme
@textlint/website-generator
Website generator using @textlint/script-compiler
Install
Install with npm:
npm install @textlint/website-generator
Usage
Usage
$ textlint-website-generator
Options
--title [String] Website page title
--placeholder [String] Placeholder text in generated website
--cwd current working directory
--textlintrc [path:String] path to .textlintrc file. Default: load .textlintrc.{json,yaml,js}
--output-dir [path:String] output file path that is written of reported result.
--metadataName [String] generated script name
--metadataNamespace [String] generated script namespace
Examples
$ textlint-website-generator --output-dir ./dist --metadataName "script name" --metadataNamespace "https://example.com"
$ textlint-website-generator --output-dir ./dist --metadataName "script name" --metadataNamespace "https://example.com" --title "rule tester" --placeholder "default text"
Changelog
See Releases page.
Running tests
Install devDependencies and Run npm test
:
npm test
Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Author
License
MIT © azu