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

Templates for arguments #197

Closed
tats-u opened this issue Aug 13, 2023 · 5 comments · Fixed by #212
Closed

Templates for arguments #197

tats-u opened this issue Aug 13, 2023 · 5 comments · Fixed by #212
Assignees
Labels
enhancement New feature or request

Comments

@tats-u
Copy link

tats-u commented Aug 13, 2023

--contentSelector="article" --paginationSelector="a.pagination-nav__link.pagination-nav__link--next" --excludeSelectors=".margin-vert--xl a,[class^='tocCollapsible'],.breadcrumbs,.theme-edit-this-page"

This software always requires a so-long options. It is so long that no one can input without reading the README. It would be nice if we can shorten this to like:

--template docusaurus2
@jean-humann
Copy link
Owner

Hi @tats-u , Thanks for the participation 👍
I agree with you on this point.
I was wondering about a subcommand such as
docs-to-pdf docusaurus encapsulating all the default flag link to docusaurus. Coud link to a --from-build flag as well.
Will do the same for other documentation framework later.
What do you think about it ?

@jean-humann jean-humann added the enhancement New feature or request label Aug 13, 2023
@jean-humann jean-humann self-assigned this Aug 13, 2023
@tats-u
Copy link
Author

tats-u commented Aug 13, 2023

Did you mean:

  • default: general purposes
  • subcommands: optimized for specific documentation frameworks e.g. Docusaurus v1 / v2

It's acceptable. Could you tell me the details of --from-build?

@jean-humann
Copy link
Owner

@tats-u exactly
--from-build would allow you to build PDF directly from the the build directory generated by docusaurus build without having to do docusaurus serve

@tats-u
Copy link
Author

tats-u commented Aug 13, 2023

@jean-humann It looks great.
--version or similar flag will be necessary to designate the version of Docusaurus.

@jean-humann jean-humann linked a pull request Aug 22, 2023 that will close this issue
@jean-humann
Copy link
Owner

@tats-u Done in #212 with --version flag

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

Successfully merging a pull request may close this issue.

2 participants