skip_docs
Skip the creation of the pantograph/README.md file when running pantograph
Tell pantograph to not automatically create a
pantograph/README.mdwhen running pantograph. You can always trigger the creation of this file manually by runningpantograph docs.
| skip_docs | |
|---|---|
| Supported platforms | mac, linux, windows |
| Author | @KrauseFx |
1 Example
skip_docs
Documentation
To show the documentation in your terminal, run
pantograph action skip_docs
CLI
It is recommended to add the above action into your Pantfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
pantograph run skip_docs
To pass parameters, make use of the : symbol, for example
pantograph run skip_docs parameter1:"value1" parameter2:"value2"
It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.
It is recommended to add all pantograph actions you use to your Pantfile.
Source code
This action, just like the rest of pantograph, is fully open source, view the source code on GitHub