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

[Jekyll Plugin] Missing code format #1970

Open
rachelcarmena opened this issue Jun 14, 2021 · 1 comment
Open

[Jekyll Plugin] Missing code format #1970

rachelcarmena opened this issue Jun 14, 2021 · 1 comment
Labels
bug format: gfm An issue/PR related to Dokka's GFM output format

Comments

@rachelcarmena
Copy link
Contributor

Describe the bug

We're using Dokka 0.10.0 and outputFormat = 'jekyll' and the code is properly formatted with the use of the corresponding delimiters.

For instance:

# Monoid

`interface Monoid<A> : `[`Semigroup`](../-semigroup/index.html)`<A>`

However, dokkaJelyll task from Dokka 1.4.32 extracts code without delimiters.

For instance, the corresponding text for the same example as before:

# Monoid  
 [common] interface [Monoid](index.md)<[A](index.md)> : [Semigroup](../-semigroup/index.md)<[A](index.md)>

Expected behaviour

We'd expect the same behavior as before with Dokka 0.10.0:

# Monoid

`interface Monoid<A> : `[`Semigroup`](../-semigroup/index.html)`<A>`

to get code properly rendered.

To Reproduce

Repository: https://github.com/arrow-kt/arrow

Steps:

  1. Generate the documentation with Dokka 0.10.0
  2. Generate the documentation with Dokka 1.4.32
  3. Compare both results

To Reproduce: Step 1 - Generate the documentation with Dokka 0.10.0

cd arrow-libs
./gradlew dokka

To Reproduce: Step 2 - Generate the documentation with Dokka 1.4.32

  1. Remove dokka configuration in arrow-libs/gradle/apidoc-creation.gradle
  2. Update arrow-libs/gradle.properties:
-DOKKA_VERSION=0.10.0
+DOKKA_VERSION=1.4.32
  1. Run dokkaJekyll:
cd arrow-libs
./gradlew dokkaJekyll

To Reproduce: Step 3 - Compare both results

For instance, compare:

./arrow-site/docs/apidocs/arrow-core/arrow.typeclasses/-monoid/index.md  --- Dokka 0.10.0
./arrow-libs/core/arrow-core/build/dokka/jekyll/arrow-core/arrow.typeclasses/-monoid/index.md --- Dokka 1.4.32

Dokka configuration

Using the default options at the beginning.

Installation

  • Operating system: macOS/Linux
  • Build tool: Gradle v6.6.1
  • Dokka version: 1.4.32

Additional context

We're trying to move from Dokka 0.10.0 to Dokka 1.4.32

Are you willing to provide a PR?

I'm willing to contribute if some guideline is provided. I just found the way to fix this thing #1968 so far.

@rachelcarmena
Copy link
Contributor Author

rachelcarmena commented Jun 16, 2021

Including .md files to show how the source code doesn't have the format delimiters with Dokka 1.4.32 (task dokkaJekyll):

@IgnatBeresnev IgnatBeresnev added the format: gfm An issue/PR related to Dokka's GFM output format label Mar 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug format: gfm An issue/PR related to Dokka's GFM output format
Projects
None yet
Development

No branches or pull requests

2 participants