diff --git a/docs/example/example-core/README.md b/docs/example/example-core/README.md --- a/docs/example/example-core/README.md +++ b/docs/example/example-core/README.md @@ -1,8 +1,8 @@ # Module Library module -This is a demonstration of how to use the Dokka format. +Welcome to Dokka in Material for MkDocs! -This text is written in a markdown file that is included in the library module. Dokka uses it to generate the module and package headers. +This page is the documentation header for the `example-core` module. It is declared using Dokka's `includes` functionality to use Markdown documents to describe modules and packages. In this file, you can include code: ```kotlin @@ -16,9 +16,11 @@ Module pages can have subheaders to describe multiple sections of content. +The behavior is identical to Dokka's headers mechanisms. + # Package opensavvy.dokka.material.mkdocs.example This is the description of a package. The description may be arbitrary long, but only the first paragraph is displayed in the module page. -However, it is contained in its entirety in the package page. +Therefore, this sentence doesn't appear in the module page, but does appear in the paragraph page.