{"id":28545208,"url":"https://github.com/playframework/play-doc","last_synced_at":"2026-03-10T11:05:10.325Z","repository":{"id":9259798,"uuid":"11085546","full_name":"playframework/play-doc","owner":"playframework","description":"Play documentation rendering support","archived":false,"fork":false,"pushed_at":"2026-03-03T08:33:16.000Z","size":826,"stargazers_count":21,"open_issues_count":8,"forks_count":22,"subscribers_count":10,"default_branch":"main","last_synced_at":"2026-03-03T12:05:03.896Z","etag":null,"topics":["documentation","playframework","sbt","sbt-plugin","scala"],"latest_commit_sha":null,"homepage":"","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/playframework.png","metadata":{"funding":{"github":["playframework"],"open_collective":"playframework"},"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2013-07-01T05:45:02.000Z","updated_at":"2026-03-03T08:33:15.000Z","dependencies_parsed_at":"2023-12-12T17:07:31.262Z","dependency_job_id":"e0142159-d24d-4f5b-b929-b44109ad0a48","html_url":"https://github.com/playframework/play-doc","commit_stats":{"total_commits":268,"total_committers":18,"mean_commits":14.88888888888889,"dds":0.8134328358208955,"last_synced_commit":"adeadb930aad09fa4f07292ba331a74d116dc46d"},"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/playframework/play-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playframework%2Fplay-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playframework%2Fplay-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playframework%2Fplay-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playframework%2Fplay-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/playframework","download_url":"https://codeload.github.com/playframework/play-doc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playframework%2Fplay-doc/sbom","scorecard":{"id":466120,"data":{"date":"2025-08-11","repo":{"name":"github.com/playframework/play-doc","commit":"c18c727d8468c3276347dd9f81c5d496e244e489"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":6.4,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":9,"reason":"Found 13/14 approved changesets -- score normalized to 9","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"19 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-test.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/playframework/play-doc/build-test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-test.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/playframework/play-doc/build-test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-test.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/playframework/play-doc/build-test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dependency-graph.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/playframework/play-doc/dependency-graph.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dependency-graph.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/playframework/play-doc/dependency-graph.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dependency-graph.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/playframework/play-doc/dependency-graph.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/playframework/play-doc/publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-drafter.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/playframework/play-doc/release-drafter.yml/main?enable=pin","Info:   0 out of   1 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   7 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build-test.yml:1","Warn: topLevel 'contents' permission set to 'write': .github/workflows/dependency-graph.yml:13","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Warn: no topLevel permission defined: .github/workflows/release-drafter.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/playframework/.github/SECURITY.md:1","Info: Found linked content: github.com/playframework/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/playframework/.github/SECURITY.md:1","Info: Found text in security policy: github.com/playframework/.github/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T12:33:20.903Z","repository_id":9259798,"created_at":"2025-08-19T12:33:20.903Z","updated_at":"2025-08-19T12:33:20.903Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30331652,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T05:25:20.737Z","status":"ssl_error","status_checked_at":"2026-03-10T05:25:17.430Z","response_time":106,"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":["documentation","playframework","sbt","sbt-plugin","scala"],"created_at":"2025-06-09T23:06:51.587Z","updated_at":"2026-03-10T11:05:10.318Z","avatar_url":"https://github.com/playframework.png","language":"Scala","readme":"\u003c!--- Copyright (C) from 2022 The Play Framework Contributors \u003chttps://github.com/playframework\u003e, 2011-2021 Lightbend Inc. \u003chttps://www.lightbend.com\u003e --\u003e\n\n# play-doc\n\n[![Twitter Follow](https://img.shields.io/twitter/follow/playframework?label=follow\u0026style=flat\u0026logo=twitter\u0026color=brightgreen)](https://twitter.com/playframework)\n[![Discord](https://img.shields.io/discord/931647755942776882?logo=discord\u0026logoColor=white)](https://discord.gg/g5s2vtZ4Fa)\n[![GitHub Discussions](https://img.shields.io/github/discussions/playframework/playframework?\u0026logo=github\u0026color=brightgreen)](https://github.com/playframework/playframework/discussions)\n[![StackOverflow](https://img.shields.io/static/v1?label=stackoverflow\u0026logo=stackoverflow\u0026logoColor=fe7a16\u0026color=brightgreen\u0026message=playframework)](https://stackoverflow.com/tags/playframework)\n[![YouTube](https://img.shields.io/youtube/channel/views/UCRp6QDm5SDjbIuisUpxV9cg?label=watch\u0026logo=youtube\u0026style=flat\u0026color=brightgreen\u0026logoColor=ff0000)](https://www.youtube.com/channel/UCRp6QDm5SDjbIuisUpxV9cg)\n[![Twitch Status](https://img.shields.io/twitch/status/playframework?logo=twitch\u0026logoColor=white\u0026color=brightgreen\u0026label=live%20stream)](https://www.twitch.tv/playframework)\n[![OpenCollective](https://img.shields.io/opencollective/all/playframework?label=financial%20contributors\u0026logo=open-collective)](https://opencollective.com/playframework)\n\n[![Build Status](https://github.com/playframework/play-doc/actions/workflows/build-test.yml/badge.svg)](https://github.com/playframework/play-doc/actions/workflows/build-test.yml)\n[![Maven](https://img.shields.io/maven-central/v/org.playframework/play-doc_2.13.svg?logo=apache-maven)](https://mvnrepository.com/artifact/org.playframework/play-doc_2.13)\n[![Repository size](https://img.shields.io/github/repo-size/playframework/play-doc.svg?logo=git)](https://github.com/playframework/play-doc)\n[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat\u0026logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)\n[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/playframework/play-doc\u0026style=flat)](https://mergify.com)\n\nThis project implements Plays documentation parsing and generating.  Documentation is in markdown with an extension that allows code snippets to come from external files.  It is used by Play to allow us to have all our documentation code snippets in external compiled and tested files, ensuring that they are accurate and up to date.\n\n## Markdown Syntax\n\nReferencing code in an external file looks like this:\n\n```markdown\n@[label](some/relative/path)\n```\n\n## Code snippet syntax\n\nCode snippets are identified using the hash symbol prepended to the label, like this:\n\n```scala\n//#label\nprintln(\"Hello world\")\n//#label\n```\n\nThe label can be anywhere in a line, and the code snippet will be every line between the start and end labels, exclusive.  Typically the snippet might be part of a test, for example:\n\n```scala\n\"List\" should {\n    \"support fold\" in {\n    //#fold\n    val list = List(1, 2, 3)\n    val sum = list.fold { (a, b) =\u003e a + b }\n    //#fold\n    sum must_== 6\n    }\n}\n```\n\nIn some rare cases, you may need to slightly modify the snippet as it stands.  Typically this might be when naming conflicts exist in the code, for example, if you want to show an entire Java class with its package name, and you have multiple places in your docs where you want to do similar, you might do this:\n\n```scala\n//#label\n//#replace package foo.bar;\npackage foo.bar.docs.sec1;\n\nclass Foo {\n    ...\n}\n//#label\n```\n\nThe supported directives are replace, skip (followed by the number of lines to skip) and insert.\n\n## Play Version\n\nAny %PLAY_VERSION% variables will be substituted with the current version of Play.\n\n## Releasing a new version\n\nSee https://github.com/playframework/.github/blob/main/RELEASING.md\n","funding_links":["https://github.com/sponsors/playframework","https://opencollective.com/playframework"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplayframework%2Fplay-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplayframework%2Fplay-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplayframework%2Fplay-doc/lists"}