{"id":13682354,"url":"https://github.com/jbake-org/jbake","last_synced_at":"2025-05-15T12:02:33.064Z","repository":{"id":7222637,"uuid":"8530120","full_name":"jbake-org/jbake","owner":"jbake-org","description":"Java based open source static site/blog generator for developers \u0026 designers.","archived":false,"fork":false,"pushed_at":"2023-02-26T11:25:24.000Z","size":6305,"stargazers_count":1132,"open_issues_count":162,"forks_count":330,"subscribers_count":76,"default_branch":"master","last_synced_at":"2025-04-14T19:59:19.824Z","etag":null,"topics":["asciidoc","asciidoctor","html","java","jbake","markdown","static-site-generator"],"latest_commit_sha":null,"homepage":"http://jbake.org","language":"Java","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/jbake-org.png","metadata":{"files":{"readme":"README.asciidoc","changelog":null,"contributing":"CONTRIBUTING.asciidoc","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.txt","authors":null}},"created_at":"2013-03-03T01:33:47.000Z","updated_at":"2025-04-14T17:27:59.000Z","dependencies_parsed_at":"2024-01-19T01:04:06.671Z","dependency_job_id":"35319962-7512-4b45-a90e-010eb2cf8b65","html_url":"https://github.com/jbake-org/jbake","commit_stats":{"total_commits":972,"total_committers":75,"mean_commits":12.96,"dds":0.6265432098765432,"last_synced_commit":"5921ee529e324d71e00a96a12968021ea12dd103"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbake-org%2Fjbake","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbake-org%2Fjbake/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbake-org%2Fjbake/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbake-org%2Fjbake/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jbake-org","download_url":"https://codeload.github.com/jbake-org/jbake/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254337612,"owners_count":22054253,"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":["asciidoc","asciidoctor","html","java","jbake","markdown","static-site-generator"],"created_at":"2024-08-02T13:01:44.643Z","updated_at":"2025-05-15T12:02:32.985Z","avatar_url":"https://github.com/jbake-org.png","language":"Java","readme":"= JBake\nJonathan Bullock\n2021-04-13\n:idprefix:\n\nhttp://jbake.org[JBake] is a Java based open source static site/blog generator for developers.\n\nimage:https://img.shields.io/github/v/release/jbake-org/jbake?label=download\u0026sort=semver[\"GitHub Release Download\", link=\"https://github.com/jbake-org/jbake/releases/latest\"]\nimage:https://img.shields.io/maven-central/v/org.jbake/jbake-core.svg[\"Maven Download\", link=\"http://jbake.org/download.html#maven\"]\nimage:https://img.shields.io/homebrew/v/jbake.svg[\"Homebrew Download\", link=\"http://jbake.org/download.html#homebrew\"]\n\nimage:https://img.shields.io/travis/com/jbake-org/jbake/master.svg[\"Build Status\", link=\"https://travis-ci.com/github/jbake-org/jbake\"]\nimage:https://ci.appveyor.com/api/projects/status/2q7hvg03wsjx953b?svg=true[\"Appveyor Status\", link=\"https://ci.appveyor.com/project/jbake-org/jbake\"]\nimage:https://img.shields.io/coveralls/jbake-org/jbake/master.svg[\"Coverage Status\", link=\"https://coveralls.io/r/jbake-org/jbake\"]\n\nimage:https://badges.gitter.im/jbake-org/jbake.svg[\"Gitter Chat\", link=\"https://gitter.im/jbake-org/jbake\"]\n\n== Documentation\n\nFull documentation is available on http://jbake.org/docs/[jbake.org].\n\n== Contributing\n\nWe welcome all contributions to the project both big and small. From new features, bug reports to even spelling mistake corrections in\nthe documentation. Please don't hesitate to submit an issue.\n\nThe link:CONTRIBUTING.asciidoc[Contributing] guide provides information on how to submit an issue or create a pull request to fix a bug or\nadd a new feature to JBake.\n\n== Versioning\n\nThe project has adopted the http://semver.org[Semantic Versioning] spec from v2.2.0 onwards to maintain an\nunderstandable backwards compatibility strategy.\n\nThe version format is as follows:\n\n----\n\u003cmajor\u003e.\u003cminor\u003e.\u003cpatch\u003e-\u003clabel\u003e\n----\n\n* An increment of the major version represents incompatible API changes.\n* An increment of the minor version represents additional functionality in a backwards-compatible manner.\n* An increment of the patch version represents backwards-compatible bug fixes.\n* Existence of a label represents a pre-release or build metadata.\n\n== Community\n\nTalk to the developers behind JBake:\n\n* http://groups.google.com/group/jbake-dev[Mailing list]\n* link:irc://irc.freenode.net/#jbake[IRC - #jbake on Freenode]\n\nTalk to other users of JBake on the forum:\n\n* http://groups.google.com/group/jbake-user[Forum]\n\n== Docker Image\n\nThe image uses the official https://hub.docker.com/r/adoptopenjdk/openjdk11/[adoptopenjdk/openjdk11:alpine] image\nfor building a distribution of JBake and\nhttps://hub.docker.com/r/adoptopenjdk/openjdk11/[adoptopenjdk/openjdk11:alpine-jre] for runtime.\n\n=== Build\n\nTo build the Docker image:\n\n----\n$ docker build -t jbake/jbake:latest .\n----\n\n=== Usage\n\nTo execute JBake via Docker run this from project directory:\n\n----\n$ docker run --rm -u jbake -v \"$PWD\":/mnt/site jbake/jbake:latest\n----\n\nThis command will execute using the jbake user to avoid running as root and will mount the current working directory as `/mnt/site`\nin the Docker container where JBake is expecting your project files to be. By default the Docker image will execute a bake `-b` only.\n\nIf you want to bake and serve your project using the Docker image then you'll need to override the default command:\n\n----\n$ docker run --rm -u jbake -v \"$PWD\":/mnt/site -p 8820:8820 jbake/jbake:latest -b -s\n----\n\nThis command will also expose port 8820 from the container, you'll also need to set the following option in your `jbake.properties` file:\n\n----\nserver.hostname=0.0.0.0\n----\n\nNOTE: Docker image timezone is _UTC_. This may affect the date and time expected in output content. To set different timezone, add `TZ` environment variable and set value to required https://en.wikipedia.org/wiki/List_of_tz_database_time_zones[timezone^]. Example - `docker run --rm -u jbake  -e TZ=America/New_York -v \"$PWD\":/mnt/site jbake/jbake:latest`\n\n\n== Build System\n\nThe project uses http://gradle.org[Gradle] 4.9+ as the build system.\nTo build the JBake distribution ZIP file execute the following command from the root of the repo:\n\n----\n$ ./gradlew distZip\n----\n\nThis will build a ZIP file in the `/build/distributions` folder.\n\nFor more information see link:BUILD.adoc[Test, Build and Deploy]\n\n== Coding conventions\n\nThe project uses a basic set of http://checkstyle.sourceforge.net/[checkstyle] rules to keep the Code in shape.\n\nWe configured the gradle checkstyle Plugin to run with the `check` task.\nIt does not break the build if convention violations are found. But prints a warning and generates a report.\n\nFor more information see link:BUILD.adoc[Test, Build and Deploy]\n\n=== Setup Intellij\n\n* Install https://github.com/jshiell/checkstyle-idea[checkstyle-idea plugin]\n+\nSettings -\u003e Plugins -\u003e CheckStyle-IDEA\n\n* Configure\n+\nSettings -\u003e Other Settings -\u003e Checksytle\n+\nAdd a new _Configuration File_.\nEnter a Description like \"jbake Checkstyle\" and choose \"Use a local Checkstyle file\".\nThe checkstyle File is located at the project root path `config/checkstyle/checkstyle.xml`\n\n* Add to Editor Code Style Scheme\n+\nSettings -\u003e Editor -\u003e Code Style\n+\nClick the gear Symbol besides the \"Scheme:\" drop-down.\n+\nImport Scheme -\u003e Checkstyle Configuration\n+\nPick the project checkstyle file `config/checkstyle/checkstyle.xml`\n\n== Tools \u0026 Libraries Used\n\n* http://commons.apache.org/[Apache Commons IO, Configuration, Lang \u0026 Logging]\n* http://args4j.kohsuke.org/[Args4j]\n* http://asciidoctor.org/[AsciidoctorJ]\n* http://freemarker.org/[Freemarker]\n* http://gradle.org[Gradle]\n* http://groovy-lang.org/[Groovy]\n* http://junit.org/[JUnit]\n* https://github.com/vsch/flexmark-java[Flexmark]\n* http://www.eclipse.org/jetty/[Jetty Server]\n* http://www.orientdb.org/[OrientDB]\n\n== Copyright \u0026 License\n\nLicensed under the MIT License, see the link:LICENSE[LICENSE] file for details.\n","funding_links":[],"categories":["Java","Apps","Uncategorized","By Language"],"sub_categories":["Development","Uncategorized","Java"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbake-org%2Fjbake","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjbake-org%2Fjbake","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbake-org%2Fjbake/lists"}