{"id":25720101,"url":"https://github.com/gregwhitaker/gradle-mkdocs-example","last_synced_at":"2026-05-03T11:32:41.014Z","repository":{"id":82732534,"uuid":"190053058","full_name":"gregwhitaker/gradle-mkdocs-example","owner":"gregwhitaker","description":"Example of building a documentation website using mkdocs and Gradle","archived":false,"fork":false,"pushed_at":"2019-06-03T18:03:21.000Z","size":764,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-25T17:41:32.611Z","etag":null,"topics":["gradle","mkdocs","mkdocs-sites"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gregwhitaker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-03T17:43:11.000Z","updated_at":"2024-01-29T23:14:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"651a1dc5-3937-41c4-9e0e-1c1d73211063","html_url":"https://github.com/gregwhitaker/gradle-mkdocs-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gregwhitaker/gradle-mkdocs-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gregwhitaker%2Fgradle-mkdocs-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gregwhitaker%2Fgradle-mkdocs-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gregwhitaker%2Fgradle-mkdocs-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gregwhitaker%2Fgradle-mkdocs-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gregwhitaker","download_url":"https://codeload.github.com/gregwhitaker/gradle-mkdocs-example/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gregwhitaker%2Fgradle-mkdocs-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32567265,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gradle","mkdocs","mkdocs-sites"],"created_at":"2025-02-25T17:36:33.836Z","updated_at":"2026-05-03T11:32:41.008Z","avatar_url":"https://github.com/gregwhitaker.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gradle-mkdocs-example\nThis project provides a template for building documentation websites with [Gradle](https://www.gradle.org) and [MkDocs](https://www.mkdocs.org/).\n\n## Prerequisites\nThis project requires that you have the following prerequisites installed on your system:\n\n* [Python](https://www.python.org/downloads/)\n* [Pip](https://pip.pypa.io/en/stable/installing/)\n\n## Development\nThe website is built using markdown files processed by [MkDocs](https://www.mkdocs.org/).\n\n### Internal Links\nWhen the production site is built, all of the markdown pages (e.g. `foo.md`) become represented in the site as `http://docs.netifi.com/x.y.z/foo/[index.html]`. This has implications for how to correctly create internal links in the documentation pages. Links that work correctly when you view the site locally (using `./gradlew mkdocsServe`) may *not* work on the live site if you do not form them properly. Consult the following chart\n\n| link format            | result |\n| ---------------------- | ------ |\n| `[link text](../page)` | **CORRECT.** |\n| `[link text](./page)`  | **INCORRECT.** Will incorrectly link to the new page as though it were in the subdirectory formed by the current page. |\n| `[link text](page)`    | **INCORRECT.** Will incorrectly link to the new page as though it were in the subdirectory formed by the current page. |\n| `[link text](/page)`   | **INCORRECT.** Will incorrectly link to the new page as through it were at the root of the docs.netifi.com site without the `x.y.z` version number. |\n\nIf you add new subdirectories to the documentation site, this may become yet more complex.\n\nThe above does not apply to the main documentation site `index.md` file. In that file, use the simple `[link text](page)` format to refer to other pages on the site.\n\n### Building the Site\nRun the following command to build the website:\n\n    ./gradlew clean mkdocsBuild\n    \nUnder the `/build` directory you will now see a `mkdocs` folder containing the latest version of the site and a master\n`index.html` file that redirects the user to the latest version of the documentation.\n\n### Adding a New Page\nFollow the steps below to add a new page to the site:\n\n1. Add new markdown file under [/src/doc/docs](./src/doc/docs)\n\n2. Update the `nav` element in [mkdocs.yml](./src/doc/mkdocs.yml) to add the page at your desired location in the site hierarchy.\n\n### Running Site with Live Reload\nDuring development it may be helpful to have the server continuously reload the site as changes are made so you can preview\nyour modifications. \n\nRun the following command to start the development server:\n\n    ./gradlew mkdocsServe\n\nThe site will be available at: [http://localhost:8000](http://localhost:8000/)\n\n## Release\nFollow the steps below to release a new version of the site:\n\n1. Update the `version` property in the root [build.gradle](./build.gradle) file to the current version.\n\n2. Run the following command to build the website:\n\n        ./gradlew clean buildRelease\n\n3. Validate that there is a new folder with the version number as the name in the `/site` directory.\n\n4. Validate that the `index.html` file in the `/site` directory redirects to the new version of the documentation.\n\n5. Check-in / merge all new files to the `master` branch in GitHub. This will kick off an automated deployment process in [Netlify](https://www.netlify.com).\n\n6. Once the Netlify deploy process has completed, validate that the website now points to the new version of the documentation.\n\n## Additional Documentation\n\n* [Material Theme](https://squidfunk.github.io/mkdocs-material/)\n* [Mkdocs](https://www.mkdocs.org/user-guide/writing-your-docs/)\n\n## License\nMIT License\n\nCopyright (c) 2019 Greg Whitaker\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgregwhitaker%2Fgradle-mkdocs-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgregwhitaker%2Fgradle-mkdocs-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgregwhitaker%2Fgradle-mkdocs-example/lists"}