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

Codeblocks from package markdown are not displayed in HTML #1371

Closed
ranile opened this issue Aug 23, 2020 · 1 comment · Fixed by #1440
Closed

Codeblocks from package markdown are not displayed in HTML #1371

ranile opened this issue Aug 23, 2020 · 1 comment · Fixed by #1440
Assignees
Labels
Milestone

Comments

@ranile
Copy link
Contributor

ranile commented Aug 23, 2020

Describe the bug
Codeblocks from package documentation markdown are not displayed at all

Expected behaviour
Codeblocks to display the code properly

To Reproduce

  • Have a codeblock in package docs for includes markdown file
  • Build HTML using dokkaHtml task
  • Observe that the HTML doesn't contain the code block

I used the following markdown to reproduce this bug:

# Package krate.binding

A binding makes a link (called a relationship) between a property of an entity class and a way of representing that relationship with SQL.

## Example

```kotlin
@SqlTable(People::class)
class Person(val name: String, uuid: UUID = UUID.randomUUID()) : Entity(uuid)
\```

Ignore the \ before ```. That is used so Github doesn't mess up the formatting

Actual results

image

Dokka configuration

    dokkaHtml {
        outputDirectory.set(File("docs/dokka"))

        dokkaSourceSets {
            configureEach {
                includeNonPublic.set(false)

                skipDeprecated.set(true)

                skipEmptyPackages.set(true)

                jdkVersion.set(8)

                includes.from("docs/krate.md")

                perPackageOption {
                    prefix.set("krate.annotations")
                    suppress.set(true)
                }

                perPackageOption {
                    prefix.set("krate.util")
                    suppress.set(true)
                }

                sourceLink {
                    localDirectory.set(projectDir)
                    remoteUrl.set(URL("https://github.com/blogify-dev/krate/blob/master/"))
                    remoteLineSuffix.set("#L")
                }
            }
        }
    }

Installation

  • Operating system: Linus (Fedora 32)
  • Build tool: Gradle v6.5
  • Dokka version: 1.4.10-dev-52 (I'm also able to reproduce this on 1.4.0-dev-48)
@ranile ranile added the bug label Aug 23, 2020
@Kordyjan Kordyjan modified the milestones: 1.4.20, Backlog 1.4.20, 1.4.20-1 Sep 2, 2020
@BarkingBad BarkingBad linked a pull request Sep 7, 2020 that will close this issue
@BarkingBad
Copy link
Contributor

Thank you for your submission. Actually, the origin of this bug is not related to codeblocks, but with @ used in your sample. I hope we can provide better solution in the future than escaping. If you are interested please follow this issue #1441

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants