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

Improve Defualt Markdown Config and Documentation #170

Open
mcmah309 opened this issue Apr 13, 2024 · 0 comments
Open

Improve Defualt Markdown Config and Documentation #170

mcmah309 opened this issue Apr 13, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@mcmah309
Copy link

I tried using this package and found setup difficult with little documentation around how this package works. The https://pub.dev/packages/flutter_markdown just works out of the box and all fields and classes are documented. This packages seems to require some sort of configuration to get styles working correctly. It is not clear how the classes compose to get desired results. It also seems like some features e.g. latex, are in the example rather than the actual package? I spent about 30 minutes trying to figure it out and realized it was not worth the effort. I think the documentation should be improved on how to setup a base looking config and make necessary changes. Also it would be nice if flavors were defaults you could just add in. Like LatexSupport or GithubFlavor.

@mcmah309 mcmah309 added the enhancement New feature or request label Apr 13, 2024
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

No branches or pull requests

1 participant