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 "conventional" defaults for cli args #10

Open
amanjeev opened this issue May 2, 2023 · 5 comments
Open

Add "conventional" defaults for cli args #10

amanjeev opened this issue May 2, 2023 · 5 comments

Comments

@amanjeev
Copy link
Member

amanjeev commented May 2, 2023

I feel like we can add some conventional defaults to the two args

  • --template
  • --output-dir
@jonathanpallant
Copy link
Member

Do you mean in the documentation / help text, or make them actually optional?

@amanjeev
Copy link
Member Author

amanjeev commented May 3, 2023

I was proposing making them actual optional.

@jonathanpallant
Copy link
Member

Like how mdbook doesn't require any args? The output directory I think you could make option, but I'm not sure about the template and the index template. It feels wrong to force defaults for the names of those files. Although I'm open to persuasion.

@Don42
Copy link

Don42 commented Aug 31, 2023

I would ask if it were possible to provide very simple default templates (baked into the binary or something), then the arguments would be optional. That would make it easier to get started without having to figure out how to write or where to copy from the different template. mdbook supports providing a template, but works without one.

I thought about using it as a way to have slides ready to give introduction talk, I don't really care what the index looks like, but it would be useful to have one.

@jonathanpallant
Copy link
Member

I'll track that in #27

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