{"id":13400801,"url":"https://github.com/google/docsy","last_synced_at":"2025-05-14T02:00:35.238Z","repository":{"id":37385167,"uuid":"153180924","full_name":"google/docsy","owner":"google","description":"Hugo theme for open source documentation","archived":false,"fork":false,"pushed_at":"2025-05-02T00:07:18.000Z","size":9653,"stargazers_count":2724,"open_issues_count":269,"forks_count":932,"subscribers_count":36,"default_branch":"main","last_synced_at":"2025-05-02T01:20:02.394Z","etag":null,"topics":["docsy","documentation-site","documentation-website","hugo","hugo-theme","theme"],"latest_commit_sha":null,"homepage":"https://docsy.dev","language":"HTML","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":"CHANGELOG.md","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}},"created_at":"2018-10-15T20:59:47.000Z","updated_at":"2025-05-02T00:07:18.000Z","dependencies_parsed_at":"2023-11-17T00:02:08.142Z","dependency_job_id":"8d9824c6-4fbb-4e8f-9961-7d326c4a2318","html_url":"https://github.com/google/docsy","commit_stats":{"total_commits":1468,"total_committers":189,"mean_commits":7.767195767195767,"dds":0.7690735694822888,"last_synced_commit":"7951194954708d7cc992e3540c8fc823cc99a953"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google%2Fdocsy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google%2Fdocsy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google%2Fdocsy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google%2Fdocsy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/google","download_url":"https://codeload.github.com/google/docsy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254052658,"owners_count":22006716,"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":["docsy","documentation-site","documentation-website","hugo","hugo-theme","theme"],"created_at":"2024-07-30T19:00:55.626Z","updated_at":"2025-05-14T02:00:35.162Z","avatar_url":"https://github.com/google.png","language":"HTML","funding_links":[],"categories":["HTML","JavaScript","others","HarmonyOS"],"sub_categories":["Windows Manager"],"readme":"# Docsy\n\n[![Project status: active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n[![Project releases](https://img.shields.io/github/release/google/docsy)](https://github.com/google/docsy/releases)\n[![Project build Status](https://badges.netlify.com/api/docsydocs.svg?branch=main)](https://app.netlify.com/sites/docsydocs/deploys)\n[![Project contributors](https://img.shields.io/github/contributors/google/docsy)](https://github.com/google/docsy/graphs/contributors)\n[![Project license](https://img.shields.io/github/license/google/docsy)](https://github.com/google/docsy/blob/main/LICENSE)\n\n\u003e **🚧 WARNING 🚧 : `main` is under development and potentially unstable! Use\n\u003e official Docsy [releases].**\n\nDocsy is a [Hugo](https://gohugo.io) theme for technical documentation sets,\nproviding simple navigation, site structure, and more.\n\nThis is not an officially supported Google product. This project is actively\nbeing maintained.\n\n## Prerequisites\n\nThe following are basic prerequisites for using Docsy in your site:\n\n- Install a recent release of the Hugo \"extended\" version. If you install from\n  the [Hugo release page](https://github.com/gohugoio/hugo/releases), make sure\n  you download the `extended` version, which supports SCSS.\n\n- Install `PostCSS` so that the site build can create the final CSS assets. You\n  can install it locally by running the following commands from the root\n  directory of your project:\n\n  ```sh\n  npm install --save-dev autoprefixer\n  npm install --save-dev postcss-cli\n  ```\n\n  Starting in\n  [version 8 of `postcss-cli`](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md),\n  you must also separately install `postcss`:\n\n  ```sh\n  npm install -D postcss\n  ```\n\nAny additional prerequisites depend on the\n[installation option](https://www.docsy.dev/docs/get-started/#installation-options)\nyou choose. We recommend using Docsy as a Hugo module, which requires that you\nhave the Go language installed in addition to Hugo and PostCSS.\n\nFor complete prerequisites and instructions, see our\n[Get started guides](https://www.docsy.dev/docs/get-started/).\n\n## Example and usage\n\nYou can find an example project that uses Docsy in the\n[Docsy Example Project repo](https://github.com/google/docsy-example).The Docsy\nExample Project is hosted at [example.docsy.dev](https://example.docsy.dev). For\nreal-life examples of sites that use Docsy (and their source repos), see our\n[Examples](https://www.docsy.dev/docs/examples/) page.\n\nTo use the Docsy theme for your own site:\n\n- (Recommended) Use the\n  [example project](https://github.com/google/docsy-example), which includes the\n  Docsy theme as a Hugo module, as a template to create your project. You can\n  customize this pre-configured basic site into your own Docsy themed site.\n  [Learn more...](https://github.com/google/docsy-example)\n\n- Add Docsy to your existing Hugo site. You can add Docsy as a Hugo module, as a\n  Git submodule, or clone the Docsy theme into your project.\n\nSee the [Get started guides](https://www.docsy.dev/docs/get-started/) for\ndetails about the various usage options.\n\n## Documentation\n\nDocsy has its own user guide (using Docsy, of course!) with lots more\ninformation about using the theme. It is hosted by [Netlify] at\n[docsy.dev](https://docsy.dev). For deploy logs and more, see [Deploys] from the\nsite's Netlify dashboard.\n\nAlternatively you can use Hugo to generate and serve a local copy of the guide\n(also useful for testing local theme changes), making sure you have installed\nall the prerequisites listed above:\n\n```sh\ngit clone --depth 1 https://github.com/google/docsy.git\ncd docsy/userguide/\nnpm install\nnpm run serve\n```\n\n## Contributing\n\nFor details on our [code of conduct] and the process for submitting pull\nrequests, see [CONTRIBUTING.md]. Thank you to all past, present, and future\n[contributors]!\n\n## License\n\nThis project is licensed under the Apache License 2.0 - see\n[LICENSE](https://github.com/google/docsy/blob/main/LICENSE) for details\n\n[code of conduct]:\n  https://github.com/google/.github/blob/master/CODE_OF_CONDUCT.md\n[CONTRIBUTING.md]: https://github.com/google/docsy/blob/main/CONTRIBUTING.md\n[contributors]: https://github.com/google/docsy/graphs/contributors\n[deploys]: https://app.netlify.com/sites/docsydocs/deploys\n[netlify]: https://netlify.com\n[releases]: https://github.com/google/docsy/releases\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoogle%2Fdocsy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoogle%2Fdocsy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoogle%2Fdocsy/lists"}