{"id":23762361,"url":"https://github.com/thymeleaf/thymeleaf-docs","last_synced_at":"2025-04-07T13:06:53.182Z","repository":{"id":8179294,"uuid":"9604143","full_name":"thymeleaf/thymeleaf-docs","owner":"thymeleaf","description":"Thymeleaf documentation","archived":false,"fork":false,"pushed_at":"2024-12-26T18:38:59.000Z","size":4366,"stargazers_count":44,"open_issues_count":18,"forks_count":55,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-31T12:07:31.611Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thymeleaf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.markdown","funding":null,"license":"LICENSE.txt","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":"2013-04-22T17:01:40.000Z","updated_at":"2024-12-26T18:34:16.000Z","dependencies_parsed_at":"2023-10-15T21:12:24.766Z","dependency_job_id":"d1ec4e88-aafd-4b1d-9b86-dd6e3d2f4006","html_url":"https://github.com/thymeleaf/thymeleaf-docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thymeleaf%2Fthymeleaf-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thymeleaf%2Fthymeleaf-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thymeleaf%2Fthymeleaf-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thymeleaf%2Fthymeleaf-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thymeleaf","download_url":"https://codeload.github.com/thymeleaf/thymeleaf-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247657281,"owners_count":20974345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-12-31T21:18:54.648Z","updated_at":"2025-04-07T13:06:53.145Z","avatar_url":"https://github.com/thymeleaf.png","language":"CSS","readme":"\nThymeleaf Docs\n==============\n\n[![build](https://github.com/thymeleaf/thymeleaf-docs/actions/workflows/build.yaml/badge.svg)](https://github.com/thymeleaf/thymeleaf-docs/actions/workflows/build.yaml)\n\nThymeleaf documentation in Markdown format, which is then converted to HTML, EPUB\n(using [Pandoc](https://johnmacfarlane.net/pandoc/)), MOBI (using [Calibre](https://calibre-ebook.com/))\nand PDF (using [wkhtmltopdf](https://wkhtmltopdf.org/))\nformats using the supplied Gradle build script.\n\nThe flavour of Markdown used is pandoc's Markdown. Its specifics and extensions can be\nexamined here: https://pandoc.org/MANUAL.html#pandocs-markdown\n\n\nTypes of documents managed\n--------------------------\n\n * Tutorials, living in `docs/tutorials`. Output: HTML, PDF, EPUB and Kindle.\n   Given their length, tutorials use their own HTML style, with an index frame\n   on the left side.\n * Articles, living in `docs/articles`. Output: HTML only. Articles are output\n   with the same HTML style as the rest of the Thymeleaf web site.\n\n\nBuilding the documentation\n--------------------------\n\nThe docs can be generated using the [\"build\" workflow](https://github.com/thymeleaf/thymeleaf-docs/actions/workflows/build.yaml)\nin GitHub Actions.  The artifact created contains the docs in the same structure\nas used for copying to and updating the Thymeleaf website (https://github.com/thymeleaf/thymeleaf.github.io).\n\nIf you want to build the docs on your own machine, then you can follow the\ninstructions below.\n\n### Dependencies / things to install\n\n - Java 11+\n - Pandoc 2.2.1+ for HTML docs: https://johnmacfarlane.net/pandoc/installing.html\n - wkhtmltopdf 0.12.6+ for PDF and EPUB/MOBI docs (optional): https://wkhtmltopdf.org/downloads.html\n - Calibre for EPUB/MOBI docs (optional): https://calibre-ebook.com/download\n\n### Generating the docs\n\nUse the Gradle wrapper build script (`./gradlew` which is included in this repo)\nto generate the documentation from the Markdown sources to your desired format,\nHTML, PDF, or e-books.  The following Gradle tasks perform these jobs:\n\n * `generateDocsHTML` - Create the HTML docs.\n * `generateDocsPDF` - Create the PDF docs (also creates the HTML docs since it\n   depends on them)\n * `generateDocsEbook` - Create the e-books.\n * `generateDocs`/`build` - Create all the above.\n\nThe generated docs will end up in the `build/site/doc` directory.  The entire\n`build/site` directory will be prepared for direct copy (`cp -R`) to the\nThymeleaf website repository for publishing.\n\n### Updating the docs for a new version\n\nTo change the version number that appears in the generated docs, update the\n`documentMetadata` object in the `build.gradle` script for the date and\nversion of docs that need updating.\n\n\nHow the docs are generated\n--------------------------\n\n**Pandoc** is used to convert the Markdown sources into HTML, using the\nappropriate HTML template in the `templates` directory, which in turn make use\nof JavaScript and CSS files copied from the `scripts` and `styles` directories.\n\n**Pandoc** is also used to generate e-books in EPUB format.\n\n**Calibre** is used to convert e-books to MOBI (Kindle) format.\n\n**wkhtmltopdf** is used to create PDF versions of the HTML docs based on the\n`media=\"print\"` stylesheet instead of the `media=\"screen\"` one you normally see\nwhen opening it in your browser.  The PDF generation task also launches a\n**Jetty** server to host the HTML files since wkhtmltopdf uses **WebKit** and\nnot using a server would prevent many of the JavaScript files in the HTML\ndocumentation from running due to WebKit's same-origin policies being stricter\nwith the `file://` protocol.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthymeleaf%2Fthymeleaf-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthymeleaf%2Fthymeleaf-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthymeleaf%2Fthymeleaf-docs/lists"}