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

How to put a README.md file on index.html page? #3546

Closed
tangible-idea opened this issue Mar 21, 2024 · 2 comments
Closed

How to put a README.md file on index.html page? #3546

tangible-idea opened this issue Mar 21, 2024 · 2 comments
Labels
question A user question, can be resolved if the question is answered/resolved

Comments

@tangible-idea
Copy link

tangible-idea commented Mar 21, 2024

Question
How to put a README.md file on index.html page?
I am using a single module project. and it works when I build it without includes syntax.

when I ./gradlew dokkaHtml it shows Unexpected classifier: "##", expected either "Module" or "Package".

Screenshots
스크린샷 2024-03-21 오전 10 09 31

Installation

  • Operating system: macOS
  • Build tool: Gradle v8.0
  • Dokka version: 1.9.20

Additional context
my gradle setup here.

dokkaHtml.configure
              {
                  dokkaSourceSets {
                      named("main") {
                          includes.from("../README.md")
                          noAndroidSdkLink.set(false) 
                      }

                  }
              }
@tangible-idea tangible-idea added the question A user question, can be resolved if the question is answered/resolved label Mar 21, 2024
@vmishenev
Copy link
Member

The markdown files from includes should have the defined format that is used for package and module documentation.
See https://kotlinlang.org/docs/dokka-gradle.html#e8d576e7
Here's an example file:

# Module kotlin-demo

This content appears under your module name.

# Package org.jetbrains.kotlin.demo

This content appears under your package name in the packages list.
It also appears under the first-level heading on your package's page.

## Level 2 heading for package org.jetbrains.kotlin.demo

Content after this heading is also part of documentation for `org.jetbrains.kotlin.demo`

# Package org.jetbrains.kotlin.demo2

This content appears under your package name in the packages list.
It also appears under the first-level heading on your package's page.

## Level 2 heading for package org.jetbrains.kotlin.demo2

Content after this heading is also part of documentation for `org.jetbrains.kotlin.demo2`

@tangible-idea
Copy link
Author

@vmishenev it is working great! thank you :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question A user question, can be resolved if the question is answered/resolved
Projects
None yet
Development

No branches or pull requests

2 participants