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

dokka-cli #2753

Closed
vampire184 opened this issue Nov 25, 2022 · 1 comment
Closed

dokka-cli #2753

vampire184 opened this issue Nov 25, 2022 · 1 comment
Labels
question A user question, can be resolved if the question is answered/resolved

Comments

@vampire184
Copy link

Question
Hi, it's me again. I have two doubts about the usage of dokka-cli:

  1. How to specify the output format as Markdown.
  2. Can the configuration parameters of sourceRoots use relative paths? after repeated testing, I found that I can only use absolute paths.

Screenshots
image

Installation

  • Operating system: macOS
  • Build tool: Gradle v7.4.2
  • Dokka version: 1.7.20
@vampire184 vampire184 added the question A user question, can be resolved if the question is answered/resolved label Nov 25, 2022
@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Dec 13, 2022

Hi! Dokka's revised documentation (#2728) is not out yet, but it covers this exact question. You can have a look at the preview: https://ignatberesnev.github.io/static/dokka/docs/kotlinlang/cli.html#other-output-formats

TLDR: you need to add gfm/jekyll plugin jars to pluginsClasspath.

Can the configuration parameters of sourceRoots use relative paths?

Unfortunately, not at the moment - there's a separate bug for it with an explanation, see #2571

Let us know if you have any other questions, I'll close this one in the meantime as it seems I've answered it :)

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