-
Notifications
You must be signed in to change notification settings - Fork 405
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
Samples are not placed in code fences for GFM #1653
Comments
We would also like to see that fixed. Code blocks now get pasted without indentation and without formatting. /**
*```json
* (write some json here)
*```
*/ The triple quotes markup disappears when converted to |
Until this is fixed, we're using awk to clean these up. https://gist.github.com/carr-disco/e58b17a75fd102de44cc7312ca4d58db |
This seems to be broken not just for GFM but also for Jekyll. |
This is definitely a blocker for hosting GFM documentation wikis. Even included *.md files are processed and code-blocks are removed from them. |
Hi, can someone please check it on Dokka 1.7.0? I believe it should be fixed, at least to some degree. Implemented in #2485 For
|
Just checked it on |
I'll close the issue as implemented/fixed, but do let us know if you encounter any other problems related to that. |
Describe the bug
Code samples are not placed in code fences with the GFM format, which makes the output very difficult to read since the code will not have syntax highlighting, nor will it be placed in a code block.
Given this documented function:
And this sample file:
./gradlew dokkaGfm
will generate anindex.md
containing this:Expected behaviour
I'd expect markdown that looks something closer to this:
Screenshots
This is an example of how the current markdown will be rendered:
Here's what I'd expect to see:
Ideally the "//sampleStart" and "//sampleEnd" would also be gone, but that's perhaps a different issue.
To Reproduce
See above for a basic example.
Here is a fork of the Dokka Gradle example from Kotlin's examples repo with a sample set up as well: dokka-gradle-example.zip
Dokka configuration
Configuration of dokka used to reproduce the bug
Installation
The text was updated successfully, but these errors were encountered: