{"id":13400793,"url":"https://github.com/google/docsy-example","last_synced_at":"2026-02-18T02:09:24.080Z","repository":{"id":37734162,"uuid":"153179091","full_name":"google/docsy-example","owner":"google","description":"An example documentation site using the Docsy Hugo theme","archived":false,"fork":false,"pushed_at":"2026-02-12T20:29:46.000Z","size":2851,"stargazers_count":553,"open_issues_count":13,"forks_count":745,"subscribers_count":18,"default_branch":"main","last_synced_at":"2026-02-13T04:31:44.802Z","etag":null,"topics":["docker","docsy","docsy-example","documentation-site","documentation-website","hugo","hugo-theme","hugo-theme-demo"],"latest_commit_sha":null,"homepage":"https://docsy.dev","language":"SCSS","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/google.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2018-10-15T20:44:11.000Z","updated_at":"2026-02-12T20:26:03.000Z","dependencies_parsed_at":"2023-12-12T20:36:07.552Z","dependency_job_id":"b04fe62d-942f-4758-ba94-500bc025f188","html_url":"https://github.com/google/docsy-example","commit_stats":{"total_commits":267,"total_committers":40,"mean_commits":6.675,"dds":0.6029962546816479,"last_synced_commit":"49b05fd9034e1fbf2ee4a828f860a7fd561cddc2"},"previous_names":[],"tags_count":14,"template":true,"template_full_name":null,"purl":"pkg:github/google/docsy-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google%2Fdocsy-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google%2Fdocsy-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google%2Fdocsy-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google%2Fdocsy-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/google","download_url":"https://codeload.github.com/google/docsy-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google%2Fdocsy-example/sbom","scorecard":{"id":436792,"data":{"date":"2025-08-11","repo":{"name":"github.com/google/docsy-example","commit":"db3d8d7266ca47b4068e6737d8363cd97980a48a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":6.5,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"Code-Review","score":10,"reason":"all changesets reviewed","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":8,"reason":"8 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 8","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"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":"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":"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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating floryn90/hugo:ext-alpine to floryn90/hugo:ext-alpine@sha256:c7f9514e92d7233f965d745e0132651909c07466e01f20719c4e8092bc95e04d","Info:   0 out of   1 containerImage 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":"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/google/.github/SECURITY.md:1","Info: Found linked content: github.com/google/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/google/.github/SECURITY.md:1","Info: Found text in security policy: github.com/google/.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":"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":"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-19T04:52:22.840Z","repository_id":37734162,"created_at":"2025-08-19T04:52:22.840Z","updated_at":"2025-08-19T04:52:22.840Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29558209,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-17T20:52:40.164Z","status":"ssl_error","status_checked_at":"2026-02-17T20:48:10.325Z","response_time":100,"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":["docker","docsy","docsy-example","documentation-site","documentation-website","hugo","hugo-theme","hugo-theme-demo"],"created_at":"2024-07-30T19:00:55.517Z","updated_at":"2026-02-18T02:09:24.075Z","avatar_url":"https://github.com/google.png","language":"SCSS","funding_links":[],"categories":["HTML","Documentation and Presentation","JavaScript"],"sub_categories":[],"readme":"# Docsy Example\n\n[Docsy][] is a [Hugo theme module][] for technical documentation sites,\nproviding easy site navigation, structure, and more. This **Docsy Example\nProject** uses the Docsy theme component as a hugo module and provides a\nskeleton documentation structure for you to use. You can clone/copy this project\nand edit it with your own content, or use it as an example.\n\nIn this project, the Docsy theme is pulled in as a Hugo module, together with\nits dependencies:\n\n```console\n$ hugo mod graph\n...\n```\n\nFor Docsy documentation, see [Docsy user guide][].\n\nThis Docsy Example Project is hosted on [Netlify][] at [example.docsy.dev][].\nYou can view deploy logs from the [deploy section of the project's Netlify\ndashboard][deploys], or this [alternate dashboard][].\n\nThis is not an officially supported Google product. This project is currently\nmaintained.\n\n## Using the Docsy Example Project as a template\n\nA simple way to get started is to use this project as a template, which gives\nyou a site project that is set up and ready to use. To do this:\n\n1. Use the dropdown for switching branches/tags to change to the **latest**\n   released tag.\n\n2. Click **Use this template**.\n\n3. Select a name for your new project and click **Create repository from\n   template**.\n\n4. Make your own local working copy of your new repo using git clone, replacing\n   https://github.com/me/example.git with your repo’s web URL:\n\n```bash\ngit clone --depth 1 https://github.com/me/example.git\n```\n\nDepending on your environment you may need to adjust the top-level `module`\nsettings in your project's Hugo config file, for example, by adding a proxy to\nuse when downloading remote modules. You can find details of what these\nconfiguration settings do in the\n[Hugo modules documentation](https://gohugo.io/hugo-modules/configuration/#module-config-top-level).\n\nOnce your settings are adjusted, you can edit your own versions of the site’s\nsource files.\n\nIf you want to do SCSS edits and want to publish these, you need to install\n`PostCSS`\n\n```bash\nnpm install\n```\n\n## Running the website locally\n\nBuilding and running the site locally requires a recent `extended` version of\n[Hugo](https://gohugo.io). You can find out more about how to install Hugo for\nyour environment in our\n[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation)\nguide.\n\nOnce you've made your working copy of the site repo, from the repo root folder,\nrun:\n\n```bash\nhugo server\n```\n\n## Running a container locally\n\nYou can run docsy-example inside a [Docker](https://docs.docker.com/) container,\nthe container runs with a volume bound to the `docsy-example` folder. This\napproach doesn't require you to install any dependencies other than\n[Docker Desktop](https://www.docker.com/products/docker-desktop) on Windows and\nMac, and [Docker Compose](https://docs.docker.com/compose/install/) on Linux.\n\n1. Build the docker image\n\n   ```bash\n   docker-compose build\n   ```\n\n1. Run the built image\n\n   ```bash\n   docker-compose up\n   ```\n\n   \u003e NOTE: You can run both commands at once with `docker-compose up --build`.\n\n1. Verify that the service is working.\n\n   Open your web browser and type `http://localhost:1313` in your navigation\n   bar, This opens a local instance of the docsy-example homepage. You can now\n   make changes to the docsy example and those changes will immediately show up\n   in your browser after you save.\n\n### Cleanup\n\nTo stop Docker Compose, on your terminal window, press **Ctrl + C**.\n\nTo remove the produced images run:\n\n```bash\ndocker-compose rm\n```\n\nFor more information see the [Docker Compose documentation][].\n\n## Using a local Docsy clone\n\nMake sure your installed go version is `1.18` or higher.\n\nClone the latest version of the docsy theme into the parent folder of your\nproject. The newly created repo should now reside in a sibling folder of your\nsite's root folder.\n\n```shell\ncd root-of-your-site\ngit clone --branch v0.12.0 https://github.com/google/docsy.git ../docsy\n```\n\nNow run:\n\n```shell\nHUGO_MODULE_WORKSPACE=docsy.work hugo server --ignoreVendorPaths \"**\"\n```\n\nor, when using npm, prepend `local` to the script you want to invoke, e.g.:\n\n```shell\nnpm run local serve\n```\n\nBy using the `HUGO_MODULE_WORKSPACE` directive (either directly or via prefix\n`local` when using npm), the server now watches all files and directories inside\nthe sibling directory `../docsy` , too. Any changes inside the local `docsy`\ntheme clone are now immediately picked up (hot reload), you can instantly see\nthe effect of your local edits.\n\nIn the command above, we used the environment variable `HUGO_MODULE_WORKSPACE`\nto tell hugo about the local workspace file `docsy.work`. Alternatively, you can\ndeclare the workspace file inside your settings file `hugo.toml`:\n\n```toml\n[module]\n  workspace = \"docsy.work\"\n```\n\nYour project's `hugo.toml` file already contains these lines, the directive for\nworkspace assignment is commented out, however. Remove the two trailing comment\ncharacters '//' so that this line takes effect.\n\n## Troubleshooting\n\nAs you run the website locally, you may run into the following error:\n\n```console\n$ hugo server\nWARN 2023/06/27 16:59:06 Module \"project\" is not compatible with this Hugo version; run \"hugo mod graph\" for more information.\nStart building sites …\nhugo v0.101.0-466fa43c16709b4483689930a4f9ac8add5c9f66+extended windows/amd64 BuildDate=2022-06-16T07:09:16Z VendorInfo=gohugoio\nError: Error building site: \"C:\\Users\\foo\\path\\to\\docsy-example\\content\\en\\_index.md:5:1\": failed to extract shortcode: template for shortcode \"blocks/cover\" not found\nBuilt in 27 ms\n```\n\nThis error occurs if you are running an outdated version of Hugo. As of docsy\ntheme version `v0.12.0`, hugo version `0.146.0` or higher is required. See this\n[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo)\nof the user guide for instructions on how to install Hugo.\n\nOr you may be confronted with the following error:\n\n```console\n$ hugo server\n\nINFO 2021/01/21 21:07:55 Using config file:\nBuilding sites … INFO 2021/01/21 21:07:55 syncing static files to /\nBuilt in 288 ms\nError: Error building site: TOCSS: failed to transform \"scss/main.scss\" (text/x-scss): resource \"scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68\" not found in file cache\n```\n\nThis error occurs if you have not installed the extended version of Hugo. See\nthis\n[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo)\nof the user guide for instructions on how to install Hugo.\n\nOr you may encounter the following error:\n\n```console\n$ hugo server\n\nError: failed to download modules: binary with name \"go\" not found\n```\n\nThis error occurs if the `go` programming language is not available on your\nsystem. See this\n[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-go-language)\nof the user guide for instructions on how to install `go`.\n\n[alternate dashboard]: https://app.netlify.com/sites/goldydocs/deploys\n[deploys]: https://app.netlify.com/sites/docsy-example/deploys\n[Docsy user guide]: https://docsy.dev/docs\n[Docsy]: https://github.com/google/docsy\n[example.docsy.dev]: https://example.docsy.dev\n[Hugo theme module]:\n  https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme\n[Netlify]: https://netlify.com\n[Docker Compose documentation]: https://docs.docker.com/compose/gettingstarted/\n\n\u003c!-- cSpell:ignore hugo docsy TOCSS --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoogle%2Fdocsy-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoogle%2Fdocsy-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoogle%2Fdocsy-example/lists"}