{"id":18277813,"url":"https://github.com/ivancheban/docsy-site","last_synced_at":"2026-06-23T03:31:39.366Z","repository":{"id":131961232,"uuid":"611869652","full_name":"ivancheban/docsy-site","owner":"ivancheban","description":"This is the code for Documentation Portal website. This is my pet project where I write articles on using static site generators, MadCap Flare, Git, and Vale linter.","archived":false,"fork":false,"pushed_at":"2025-01-31T09:05:46.000Z","size":37535,"stargazers_count":2,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-24T17:00:55.126Z","etag":null,"topics":["git","madcap","static-site-generator","vale"],"latest_commit_sha":null,"homepage":"https://tw-docs.com","language":"JavaScript","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/ivancheban.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}},"created_at":"2023-03-09T17:56:16.000Z","updated_at":"2025-01-31T09:05:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"a83037f9-452f-4f31-9e2b-ae1accdff572","html_url":"https://github.com/ivancheban/docsy-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ivancheban/docsy-site","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivancheban%2Fdocsy-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivancheban%2Fdocsy-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivancheban%2Fdocsy-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivancheban%2Fdocsy-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ivancheban","download_url":"https://codeload.github.com/ivancheban/docsy-site/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivancheban%2Fdocsy-site/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34674702,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-23T02:00:07.161Z","response_time":65,"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":["git","madcap","static-site-generator","vale"],"created_at":"2024-11-05T12:21:07.712Z","updated_at":"2026-06-23T03:31:39.346Z","avatar_url":"https://github.com/ivancheban.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docsy Example\n\n[Docsy](https://github.com/google/docsy) is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more. This **Docsy Example Project** uses the Docsy theme, as well as providing a skeleton documentation structure for you to use. You can either copy this project and edit it with your own content, or use the theme in your projects like any other [Hugo theme](https://gohugo.io/themes/installing-and-using-themes/).\n\nThis Docsy Example Project is hosted at [https://example.docsy.dev/](https://example.docsy.dev/).\n\nYou can find detailed theme instructions in the Docsy user guide: https://docsy.dev/docs/\n\nThis is not an officially supported Google product. This project is currently maintained.\n\n## Cloning the Docsy Example Project\n\nThe following will give you a project that is set up and ready to use (don't forget to use `--recurse-submodules` or you won't pull down some of the code you need to generate a working site). The `hugo server` command builds and serves the site. If you just want to build the site, run `hugo` instead.\n\n```bash\ngit clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git\ncd docsy-example\nhugo server\n```\n\nThe theme is included as a Git submodule:\n\n```bash\n▶ git submodule\n a053131a4ebf6a59e4e8834a42368e248d98c01d themes/docsy (heads/master)\n```\n\nIf you want to do SCSS edits and want to publish these, you need to install `PostCSS` (not needed for `hugo server`):\n\n```bash\nnpm install\n```\n\n\u003c!--### Cloning the Example from the Theme Project\n\n\n```bash\ngit clone --recurse-submodules --depth 1 https://github.com/docsy.git\ncd tech-doc-hugo-theme/exampleSite\nHUGO_THEMESDIR=\"../..\" hugo server\n```\n\n\nNote that the Hugo Theme Site requires the `exampleSite` to live in a subfolder of the theme itself. To avoid recursive duplication, the example site is added as a Git subtree:\n\n```bash\ngit subtree add --prefix exampleSite https://github.com/google/docsy.git  master --squash\n```\n\nTo pull in changes, see `pull-deps.sh` script in the theme.--\u003e\n\n## Running the website locally\n\nOnce you've cloned the site repo, from the repo root folder, run:\n\n```\nhugo server\n```\n\n\u003e **Note**\n\u003e\n\u003e You can run `hugo serve` with the same result.\n\n### Running a container locally\n\nYou can run docsy-example inside a [Docker](ihttps://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.\n\n1. Build the docker image \n\n```bash\ndocker build -f dev.Dockerfile -t docsy-example-dev:latest .\n```\n\n1. Run the built image\n\n```bash\ndocker run --publish 1313:1313 --detach --mount src=\"$(pwd)\",target=/home/docsy/app,type=bind docsy-example-dev:latest\n```\n\nOpen your web browser and type `http://localhost:1313` in your navigation bar,\nThis opens a local instance of the docsy-example homepage. You can now make\nchanges to the docsy example and those changes will immediately show up in your\nbrowser after you save.\n\nTo stop the container, first identify the container ID with:\n\n```bash\ndocker container ls\n```\n\nTake note of the hexadecimal string below the `CONTAINER ID` column, then stop\nthe container:\n\n```bash\ndocker stop [container_id]\n```\n\nTo delete the container run:\n\n```\ndocker container rm [container_id]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivancheban%2Fdocsy-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fivancheban%2Fdocsy-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivancheban%2Fdocsy-site/lists"}