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

Marked CLI Help Won't Open #992

Closed
crutchcorn opened this issue Dec 28, 2017 · 6 comments · Fixed by #1009
Closed

Marked CLI Help Won't Open #992

crutchcorn opened this issue Dec 28, 2017 · 6 comments · Fixed by #1009

Comments

@crutchcorn
Copy link

Expectation

Whern I run marked --help, I'd like to see a simple manpage of some kind. Really, just any kind of output.

Result

marked --help
(node:21012) [DEP0006] DeprecationWarning: child_process: options.customFds option is deprecated. Use options.stdio instead.
events.js:183
      throw er; // Unhandled 'error' event
      ^

Error: spawn man ENOENT
    at _errnoException (util.js:1024:11)
    at Process.ChildProcess._handle.onexit (internal/child_process.js:190:19)
    at onErrorNT (internal/child_process.js:372:16)
    at _combinedTickCallback (internal/process/next_tick.js:138:11)
    at process._tickCallback (internal/process/next_tick.js:180:9)
    at Function.Module.runMain (module.js:678:11)
    at startup (bootstrap_node.js:187:16)
    at bootstrap_node.js:608:3
@Feder1co5oave
Copy link
Contributor

I guess you don't have man available on your system? is that the cause of the error?

@crutchcorn
Copy link
Author

On my system (Windows 10), man runs:

TOPIC
    Windows PowerShell Help System

So I'm not sure if that's the problem

@Feder1co5oave
Copy link
Contributor

Yep, marked needs a Unix-style man. We should migrate away from this in the future. Please refer to README.md for now!

@crutchcorn
Copy link
Author

crutchcorn commented Jan 5, 2018

Actually, the README is missing a significant amount of information as to what the CLI is capable of (input, output, etc etc) so I would refer people experiencing the same issue here:
https://github.com/chjj/marked/blob/master/man/marked.1
Which is what the CLI is supposed to show for help (as I know you know :) )

@joshbruce
Copy link
Member

Question, as this seems to be the appropriate place to bring it up.

Marked seems to ultimately be a dual product. An imported library, which I understand and makes sense. And it's also a CLI tool.

What are people using the CLI for exactly? What value does it bring to developers?

@crutchcorn
Copy link
Author

I'll give you a great example of what I used the CLI for:
I much prefer using Markdown instead of HTML to do document writing and have an incredibly small page that I needed some layout for. So, I quickly wrote up some CSS for the markdown that was generated with the CLI, and boom - done in 10 minutes instead of having to use the library and add much more code to the codebase

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

Successfully merging a pull request may close this issue.

3 participants