-
Notifications
You must be signed in to change notification settings - Fork 349
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
Fixed heading in markdown doc #258
Conversation
Hi, Read the documentation and saw that the configuration part of the first doc string is not rendered correctly. There's a missing newline/empty line before the heading Configuration.
1 similar comment
Apparently, the heading (`#`) construct doesn't work in `@moduledoc`. Made a poor-mans-heading instead. Commit if you want to
### Configuring | ||
|
||
**Configuring** | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This replaces an <h3>
in the generated output with a <strong>
tag.
Ideally, it should be enough of a fix to simply keep the ### Configuring
and and a new line before AND after it.
Did you try that and it did not work?
Hi, yes, I tried that and for some reason, that formatting doesn't work in the I'm not happy with this but it's at least better than the output today that contains the If you want to drop this PR I totally understand. Just saw it in the docs and thought I'd try to fix it. |
@marcusoftnet Seems you're right. I even tried updating Oh well, it might not be an actual header, but it looks like one, compared to what it previously looked like, so I'd say this is good to go. |
Thank you @marcusoftnet 👍 |
Awesome! That's how i thought about it too! Thanks a lot |
Should we perhaps try to find when the issue happens exactly and submit an issue to ex_doc? |
Oh, lovely - I think I could do that. Is that a separate repo? |
How I would go about this
|
Hi,
Read the documentation and saw that the configuration part of the first doc string is not rendered correctly.
There's a missing newline/empty line before the heading Configuration.