- Documentation
- Includes package-level documentation support (
src/commonMain/resources/package_docs) - Includes code snippet support in documentation (
src/commonMain/resources/samples)
- Includes package-level documentation support (
- GitHub Actions
- Regenerates
gh-pageswith fresh documentation whenmainbranch changes - Publishes to an OSSRH staging repository whan
mainbranch changes
- Regenerates
- Assign the following values in
gradle.properties, according to the comments above them:project.nameproject.group_idauthor.usernameauthor.email
- Go to
src/commonMain/resources/package_docs/Example.md, and either...- delete the file
- replace
<PROJECT>with the same value you used forproject.namein step 1.i.
- Go to your GitHub repository's
Settings > Secrets > Actions > New- Create
OSSRH_USERNAMEandOSSRH_PASSWORDwith either...- your actual username and password
- the username and password value of a "user token" for your account (recommended)
- Create
- Open
~/.gradle/gradle.properties(create the file if it's missing)- Add the following to the end of the file:
ossrhUsername = '...' // Same value as OSSRH_USERNAME from step 3.i ossrhPassword = '...' // Same value as OSSRH_PASSWORD from step 3.i