{"id":16582209,"url":"https://github.com/deining/doc-ex","last_synced_at":"2026-03-18T20:40:30.598Z","repository":{"id":103260935,"uuid":"478998254","full_name":"deining/doc-ex","owner":"deining","description":"Docsy example site","archived":false,"fork":false,"pushed_at":"2023-12-06T20:28:44.000Z","size":893,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-06T02:24:51.450Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/deining.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}},"created_at":"2022-04-07T13:30:24.000Z","updated_at":"2022-04-07T13:30:30.000Z","dependencies_parsed_at":"2024-11-15T23:37:29.952Z","dependency_job_id":"36cee885-a4c8-483e-b835-8db2b703a56f","html_url":"https://github.com/deining/doc-ex","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"google/docsy-example","purl":"pkg:github/deining/doc-ex","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deining%2Fdoc-ex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deining%2Fdoc-ex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deining%2Fdoc-ex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deining%2Fdoc-ex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deining","download_url":"https://codeload.github.com/deining/doc-ex/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deining%2Fdoc-ex/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30191474,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T18:30:16.692Z","status":"ssl_error","status_checked_at":"2026-03-06T18:30:13.818Z","response_time":250,"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":[],"created_at":"2024-10-11T22:31:56.699Z","updated_at":"2026-03-06T18:44:19.384Z","avatar_url":"https://github.com/deining.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docsy Example\n\n[Docsy][] is a [Hugo theme][] for technical documentation sites, providing easy\nsite navigation, structure, and more. This **Docsy Example Project** uses the\nDocsy theme and provides a skeleton documentation structure for you to use. You\ncan clone/copy this project and edit it with your own content, or use it as an\nexample.\n\nIn this project, the Docsy theme is included as a Git submodule:\n\n```bash\n$ git submodule\n...\u003chash\u003e... themes/docsy (remotes/origin/HEAD)\n```\n\nYou can find detailed theme instructions in the [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 maintained.\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 you a site project that is set up and ready to use. To do this: \n\n1. Click **Use this template**.\n\n2. Select a name for your new project and click **Create repository from template**.\n\n3. Make your own local working copy of your new repo using git clone, replacing https://github.com/me/example.git with your repo’s web URL:\n\n```bash\ngit clone --recurse-submodules --depth 1 https://github.com/me/example.git\n```\n\nYou can now edit your own versions of the site’s source files.\n\nIf you want to do SCSS edits and want to publish these, you need to install `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 [Hugo](https://gohugo.io).\nYou can find out more about how to install Hugo for your environment in our\n[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation) guide.\n\nOnce you've made your working copy of the site repo, from the repo root folder, run:\n\n```\nhugo server\n```\n\n## Running a container locally\n\nYou can run docsy-example inside a [Docker](https://docs.docker.com/)\ncontainer, the container runs with a volume bound to the `docsy-example`\nfolder. This approach doesn't require you to install any dependencies other\nthan [Docker Desktop](https://www.docker.com/products/docker-desktop) on\nWindows and Mac, and [Docker Compose](https://docs.docker.com/compose/install/)\non 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 bar,\n   This opens a local instance of the docsy-example homepage. You can now make\n   changes to the docsy example and those changes will immediately show up in your\n   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```console\ndocker-compose rm\n```\nFor more information see the [Docker Compose\ndocumentation](https://docs.docker.com/compose/gettingstarted/).\n\n## Troubleshooting\n\nAs you run the website locally, you may run into the following error:\n\n```\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.\nSee our [user guide](https://www.docsy.dev/docs/getting-started/) for instructions on how to install Hugo.\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]: https://www.mikedane.com/static-site-generators/hugo/installing-using-themes/\n[Netlify]: https://netlify.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeining%2Fdoc-ex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeining%2Fdoc-ex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeining%2Fdoc-ex/lists"}