Skip to content

Commit

Permalink
add dokka gfm step, fix path
Browse files Browse the repository at this point in the history
  • Loading branch information
kyeotic committed Nov 21, 2024
1 parent f52fd9a commit 9bee850
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
9 changes: 7 additions & 2 deletions .github/workflows/Publish-Website.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
name: Publish the mkdocs to gh-pages

on:
release:
types: [published]
push:
paths:
- "docs/**"
- "*.md"
- "mkdocs.yml"
branches:
- main

env:
GRADLE_OPTS: -Dorg.gradle.configureondemand=true -Dorg.gradle.parallel=true -Dkotlin.incremental=false -Dorg.gradle.jvmargs="-Xmx3g -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8"
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/prepare_mkdocs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ set -ex

# Generate the API docs
bin/gradle dokkaHtml
bin/gradle dokkaGfm

# Dokka filenames like `-http-url/index.md` don't work well with MkDocs <title> tags.
# Assign metadata to the file's first Markdown heading.
Expand Down
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ subprojects {
}

if (dokkaTask.name == "dokkaGfm") {
outputDirectory.set(project.file("$rootDir/docs/0.x"))
outputDirectory.set(project.file("$rootDir/docs/1.x"))
}
}
}
Expand Down

0 comments on commit 9bee850

Please sign in to comment.