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.

Sign up for GitHub

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

Jump to bottom

Use mdoc in readme #37

Open
kubukoz opened this issue May 13, 2021 · 0 comments
Open

Use mdoc in readme #37

kubukoz opened this issue May 13, 2021 · 0 comments

Comments

@kubukoz
Copy link
Member

kubukoz commented May 13, 2021 •
edited
Loading

The readme file could live somewhere in a docs project, and be generated with mdoc. This doesn't need to be plugged into the CI, just an sbt command to generate that would be pretty cool.

One thing to note is that I'm not sure how the plugin will see the classes in mdoc fences (nested or not).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kubukoz