{"id":19891343,"url":"https://github.com/lightbend/sbt-paradox-project-info","last_synced_at":"2025-05-02T18:31:16.649Z","repository":{"id":36293019,"uuid":"158836325","full_name":"lightbend/sbt-paradox-project-info","owner":"lightbend","description":"A Paradox directive to include standardised project information into the generated documentation","archived":false,"fork":false,"pushed_at":"2024-01-31T10:42:15.000Z","size":86,"stargazers_count":5,"open_issues_count":4,"forks_count":5,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-07T04:36:53.953Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Scala","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/lightbend.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}},"created_at":"2018-11-23T13:26:41.000Z","updated_at":"2023-07-25T14:21:37.000Z","dependencies_parsed_at":"2024-01-31T11:50:34.323Z","dependency_job_id":null,"html_url":"https://github.com/lightbend/sbt-paradox-project-info","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fsbt-paradox-project-info","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fsbt-paradox-project-info/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fsbt-paradox-project-info/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fsbt-paradox-project-info/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lightbend","download_url":"https://codeload.github.com/lightbend/sbt-paradox-project-info/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252088404,"owners_count":21692789,"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-11-12T18:17:55.530Z","updated_at":"2025-05-02T18:31:16.034Z","avatar_url":"https://github.com/lightbend.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sbt-paradox-project-info [![maven-central-badge][]][maven-central][![github-actions-badge][]][github-actions]\n\nA [paradox](https://github.com/lightbend/paradox/) directive that includes standardised project information in the generated documentation.\n\n## Usage\n\nAdd the Paradox plug-in as sbt plug-on\n\n```scala\naddSbtPlugin(\"com.lightbend.paradox\" % \"sbt-paradox-project-info\" % \u003clatest\u003e)\n```\n\nCreate a project info file in `project/project-info.conf` using HOCON format:\n\n```hocon\nproject-info {\n  # version is overridden from the `projectInfoVersion` key (which defaults to sbt's project version)\n  version: \"current\"\n  scala-versions: [\"2.12\", \"2.13\"]\n  jdk-versions: [\"OpenJDK 8\"]\n  core {\n    title: \"The core project\"\n    // if undefined, sbt's crossScalaVersions are used\n    scala-versions: ${project-info.scala-versions}\n    jdk-versions: ${project-info.jdk-versions}\n    jpms-name: \"alpakka.core\"\n    snapshots: {\n      text: \"Snapshots are available\"\n      url: \"snapshots.html\"\n      new-tab: false\n    }\n    issues: {\n      url: \"https://github.com/lightbend/sbt-paradox-project-info/issues\"\n      text: \"Github issues\"\n    }\n    release-notes: {\n      url: \"https://github.com/lightbend/sbt-paradox-project-info/releases\"\n      text: \"Github releases\"\n    }\n    api-docs: [\n      {\n        text: \"Scaladoc\"\n        url: \"https://developer.lightbend.com/docs/api/alpakka/\"${project-info.version}\"/akka/stream/alpakka/index.html\"\n      }\n    ]\n    forums: [\n      {\n        text: \"Lightbend Discuss\"\n        url: \"https://discuss.lightbend.com/c/akka/\"\n      }\n      {\n        text: \"akka/alpakka-kafka Gitter channel\"\n        url: \"https://gitter.im/akka/alpakka-kafka\"\n      }\n    ]\n  }\n}\n```\n[Full Source](https://github.com/lightbend/sbt-paradox-project-info/blob/master/src/sbt-test/project-info/happy-path/project/project-info.conf)\n\nUse the `@@project-info` directive in the Paradox markdown files and reference the project by its sbt `projectId` (when using the `project` sbt macro it is the name of the `val`).\n\n```markdown\n# The Test Kit\n\n@@project-info { projectId=\"core\" }\n\nThe quick brown fox...\n\n```\n[Example](https://github.com/lightbend/sbt-paradox-project-info/blob/master/src/sbt-test/project-info/happy-path/src/main/paradox/index.md)\n\n### Readiness Levels\n\nReadiness levels is a convenient way to show the support for different projects. In order to use readiness levels you\nfirst need to specify what they mean and how to render them, i.e.\n\n```sbt\nimport com.lightbend.paradox.projectinfo._\nimport com.lightbend.paradox.projectinfo.ParadoxProjectInfoPluginKeys._\n\nreadinessLevels ++= Map(\n  \"Supported\" -\u003e new ReadinessLevel {\n    val name = \"\u003cb\u003eThis project is supported\u003c/b\u003e\"\n  },\n  \"NotSupported\" -\u003e new ReadinessLevel {\n    val name = \"\u003cb\u003eThis project is not supported\u003c/b\u003e\"\n  }\n)\n```\n\nIt's also possible to abstract away the `readinessLevels` setting into a sbt plugin which is convenient if you are using\nthe same configured levels in multiple projects (typical for an organization/company). For an example of this have a\nlook [here](https://github.com/lightbend/sbt-paradox-lightbend-project-info).\n\nThen in your `project/project-info.conf` you can specify these readiness levels using the `levels` config path, i.e.\n\n```hocon\nproject-info {\n  # version is overridden from the `projectInfoVersion` key (which defaults to sbt's project version)\n  version: \"current\"\n  scala-versions: [\"2.12\", \"2.13\"]\n  jdk-versions: [\"OpenJDK 8\"]\n  core {\n    title: \"The core project\"\n    // if undefined, sbt's crossScalaVersions are used\n    scala-versions: ${project-info.scala-versions}\n    jdk-versions: ${project-info.jdk-versions}\n    jpms-name: \"alpakka.core\"\n    snapshots: {\n      text: \"Snapshots are available\"\n      url: \"snapshots.html\"\n      new-tab: false\n    }\n    issues: {\n      url: \"https://github.com/lightbend/sbt-paradox-project-info/issues\"\n      text: \"Github issues\"\n    }\n    release-notes: {\n      url: \"https://github.com/lightbend/sbt-paradox-project-info/releases\"\n      text: \"Github releases\"\n    }\n    api-docs: [\n      {\n        text: \"Scaladoc\"\n        url: \"https://developer.lightbend.com/docs/api/alpakka/\"${project-info.version}\"/akka/stream/alpakka/index.html\"\n      }\n    ]\n    forums: [\n      {\n        text: \"Lightbend Discuss\"\n        url: \"https://discuss.lightbend.com/c/akka/\"\n      }\n      {\n        text: \"akka/alpakka-kafka Gitter channel\"\n        url: \"https://gitter.im/akka/alpakka-kafka\"\n      }\n    ]\n    levels: [\n      {\n        readiness: Supported\n        since: \"2018-11-22\"\n        since-version: \"0.22\"\n      }\n      {\n        readiness: NotSupported\n        since: \"2018-08-22\"\n        since-version: \"0.16\"\n        note: \"Alpha level of module\"\n      }\n    ]\n  }\n}\n```\n\n## License\n\nThe license is Apache 2.0, see LICENSE.\n\n## Maintenance notes\n\n**This project is NOT supported under the Lightbend subscription.**\n\nFeel free to ping contributors for code review or discussions. Pull requests are very welcome–thanks in advance!\n\n[maven-central]:         https://maven-badges.herokuapp.com/maven-central/com.lightbend.paradox/sbt-paradox-project-info\n[maven-central-badge]:   https://maven-badges.herokuapp.com/maven-central/com.lightbend.paradox/sbt-paradox-project-info/badge.svg\n[github-actions]:        https://github.com/lightbend/sbt-paradox-project-info/actions/workflows/ci.yml?query=branch%3Amain\n[github-actions-badge]:  https://github.com/lightbend/sbt-paradox-project-info/actions/workflows/ci.yml/badge.svg?branch=main\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightbend%2Fsbt-paradox-project-info","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flightbend%2Fsbt-paradox-project-info","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightbend%2Fsbt-paradox-project-info/lists"}