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

[docs] add configuration usage #46

Closed
marcfranquesa opened this issue Oct 18, 2024 · 1 comment
Closed

[docs] add configuration usage #46

marcfranquesa opened this issue Oct 18, 2024 · 1 comment

Comments

@marcfranquesa
Copy link
Contributor

First of all, thank you! I found this formatter recently and I am really liking it.

I think it would be nice to add documentation on the available flags to change the settings (i.e. --tab 4). Also relating to this issue, when the config file is implemented to document the usage. Could be a section added to the README? I can start up an initial draft.

Also opened a PR to include tex-fmt in the Mason registry, hope that is ok!

@marcfranquesa marcfranquesa changed the title [feat] configuration documentation [docs] add configuration usage Oct 19, 2024
@WGUNDERWOOD
Copy link
Owner

Now that tex-fmt is becoming a little more complex, I think this is a good idea! Perhaps we can keep the "Usage" section in the README as it is now, containing just the most useful flags. We can then add a new section called "Options" at the very bottom of the README, documenting each flag in more detail. Feel free to make a draft PR and I can take a look.

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

2 participants