File tree Expand file tree Collapse file tree 1 file changed +6
-0
lines changed Expand file tree Collapse file tree 1 file changed +6
-0
lines changed Original file line number Diff line number Diff line change @@ -9,6 +9,7 @@ This is a template for creating Android Open Source libraries. This template fea
9
9
- :package : Dependency management with Version Catalogue
10
10
- :memo : CHANGELOG following a keepchangelog.com format
11
11
- :wrench : Gradle Convention Plugins for consistent build configuration across modules
12
+ - 🌐GH pages to host the documentation
12
13
13
14
## Table of Contents
14
15
- [ Usage] ( #usage )
@@ -89,6 +90,11 @@ The Dokka plugin is applied to the library module and generates KDocks documenta
89
90
library. The generated documentation is published together with the project documentation and can be
90
91
accessed using github pages.
91
92
93
+ ### Github Pages
94
+ Every push to the ` main ` branch triggers the ` Generate Docs ` workflow that will generate the documentation and
95
+ publish it to the ` gh-pages ` branch. The documentation can be accessed using the following link:
96
+ ` https://<username>.github.io/<repository-name>/ `
97
+
92
98
93
99
## Contributing
94
100
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
You can’t perform that action at this time.
0 commit comments