Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please document how to use the html-pipeline binary without command‐line arguments! #213

Closed
ytrezq opened this issue Aug 15, 2015 · 5 comments

Comments

@ytrezq
Copy link

ytrezq commented Aug 15, 2015

Something like a manpage or info page would be welcome. However I don’t understand at all how to use it.

@JuanitoFatas
Copy link
Contributor

We have a usage section in our README. Does this help?

@ytrezq ytrezq changed the title Please document how to use the html-pipeline binary! Please document how to use the html-pipeline binary without arguments! Aug 15, 2015
@ytrezq ytrezq changed the title Please document how to use the html-pipeline binary without arguments! Please document how to use the html-pipeline binary without command‐line arguments! Aug 15, 2015
@JuanitoFatas
Copy link
Contributor

Please document how to use the html-pipeline binary without arguments! to Please document how to use the html-pipeline binary without command‐line arguments!

I see.

@jch This script committed in 5e9688f. But we did have a spec.executables entry in gemspec (removed in a214dd4).

@ytrezq If you want to use it now, we did not package in the gem, you will need to download it to your machine, store in any of your $PATH. Usage can be seen by typing html-pipeline -h:

$ html-pipeline -h
Usage: html-pipeline [-h] [-f]
       html-pipeline [FILTER [FILTER [...]]] < file.md
       cat file.md | html-pipeline [FILTER [FILTER [...]]]
Options:
    -f, --filters                    List the available filters

If you already know how to use it and asking for documentations, would you mind open a Pull Request?

Hope this helps. Thank you!

@ytrezq
Copy link
Author

ytrezq commented Aug 15, 2015

@JuanitoFatas : Sorry but I was talking about this script since the beginning. So no, this doesn’t help and I still don’t understand to use the standalone mode without filter names (sh -c "$PWD/html-pipeline").

@gjtorikian
Copy link
Owner

Old issue, not sure what's being asked, please reopen if there's still and issue.

@ytrezq
Copy link
Author

ytrezq commented Feb 16, 2021

@gjtorikian as the original poster I can reopen this issue. Please do it.

As explained there s absolutely no help text explained is to do be able to use html-pipeline with default, options. That is, without optional filters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants