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

Add a CLI mode to the parser (cli.mjs) #3

Closed
ovflowd opened this issue May 30, 2024 · 2 comments · Fixed by #36
Closed

Add a CLI mode to the parser (cli.mjs) #3

ovflowd opened this issue May 30, 2024 · 2 comments · Fixed by #36
Assignees

Comments

@ovflowd
Copy link
Member

ovflowd commented May 30, 2024

After completing #1, we aim to add a "JavaScript binary" that you can quickly call, following NPM's package.json documentation for bin.

This aims to provide functionality to:

  • Provide a glob for input (-i)
    • This can be a single API doc file, or a glob to all markdown files of a folder or subfolder (like doc/api/*.md
  • Provide an output folder path -o
    • This is not a glob but simple a directory to output generated contents
    • File names will match input file names
  • Provide an execution target mode (-t)
    • Initially it will only support mdx this can be a comma-separated value of one or more output formats we'll support in the future (like json, html, mdx)

This file should be stored within a bin/cli.mjs file

@ovflowd
Copy link
Member Author

ovflowd commented Jul 5, 2024

cc @canerakdas I remember you were looking for options here?

@canerakdas
Copy link
Member

cc @canerakdas I remember you were looking for options here?

Yes, I'm working on it 🚀

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

Successfully merging a pull request may close this issue.

2 participants