{"id":14983550,"url":"https://github.com/grpc/grpc.io-docsy","last_synced_at":"2025-10-03T04:31:13.172Z","repository":{"id":46157860,"uuid":"342417052","full_name":"grpc/grpc.io-docsy","owner":"grpc","description":"A fork of google/docsy used by grpc.io.","archived":false,"fork":true,"pushed_at":"2024-07-24T19:41:57.000Z","size":8678,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"grpc.io","last_synced_at":"2025-01-22T06:37:00.957Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"google/docsy","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grpc.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}},"created_at":"2021-02-26T00:28:54.000Z","updated_at":"2024-07-24T19:42:03.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/grpc/grpc.io-docsy","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/grpc/grpc.io-docsy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grpc%2Fgrpc.io-docsy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grpc%2Fgrpc.io-docsy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grpc%2Fgrpc.io-docsy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grpc%2Fgrpc.io-docsy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grpc","download_url":"https://codeload.github.com/grpc/grpc.io-docsy/tar.gz/refs/heads/grpc.io","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grpc%2Fgrpc.io-docsy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278113373,"owners_count":25932120,"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","status":"online","status_checked_at":"2025-10-03T02:00:06.070Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-09-24T14:07:25.025Z","updated_at":"2025-10-03T04:31:12.536Z","avatar_url":"https://github.com/grpc.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docsy\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  ```console\n  $ npm install --save-dev autoprefixer\n  $ npm install --save-dev postcss-cli\n  ```\n\n## Example and usage\n\nYou can find an example project that uses Docsy in the [Docsy Example Project\nrepo](https://github.com/google/docsy-example).The Docsy Example Project is\nhosted 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 [example\n  project](https://github.com/google/docsy-example), which includes the Docsy\n  theme as a Hugo module, as a template to create your project. You can customize\n  this pre-configured basic site into your own Docsy themed site. [Learn\n  more...](https://github.com/google/docsy-example)\n\n- Add Docsy to your existing Hugo site repo's `themes` directory. You can\n  either add Docsy as a Git submodule, or clone the Docsy theme into your\n  project.\n\nSee the [Docsy Getting Started Guide](https://docsy.dev/docs/getting-started/)\nfor details 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\nthe site'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```console\n$ git clone --depth 1 https://github.com/google/docsy.git\n$ cd docsy/userguide/\n$ npm install\n$ npm run serve\n```\n\n## Contributing ![GitHub](https://img.shields.io/github/contributors/google/docsy)\n\nPlease read\n[CONTRIBUTING.md](https://github.com/google/docsy/blob/main/CONTRIBUTING.md)\nfor details on our code of conduct, and the process for submitting pull requests\nto us. See also the list of\n[contributors](https://github.com/google/docsy/graphs/contributors) who\nparticipated in this project.\n\n## License ![GitHub](https://img.shields.io/github/license/google/docsy)\n\nThis project is licensed under the Apache License 2.0 - see the\n[LICENSE.md](https://github.com/google/docsy/blob/main/LICENSE) file for\ndetails\n\n[Deploys]: https://app.netlify.com/sites/docsydocs/deploys\n[Netlify]: https://netlify.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrpc%2Fgrpc.io-docsy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrpc%2Fgrpc.io-docsy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrpc%2Fgrpc.io-docsy/lists"}