{"id":43849195,"url":"https://github.com/gitxtui/docs","last_synced_at":"2026-02-06T06:15:08.281Z","repository":{"id":304809669,"uuid":"1020059673","full_name":"gitxtui/docs","owner":"gitxtui","description":"gitx docs","archived":false,"fork":false,"pushed_at":"2026-02-03T06:12:09.000Z","size":2005,"stargazers_count":2,"open_issues_count":3,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-02-03T19:16:57.808Z","etag":null,"topics":["cli","docsy","git","hacktoberfest","hacktoberfest2025","hugo","learning","tui","vcs"],"latest_commit_sha":null,"homepage":"https://gitxtui.github.io/docs/","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/gitxtui.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":"2025-07-15T09:24:13.000Z","updated_at":"2026-02-03T06:12:06.000Z","dependencies_parsed_at":"2025-07-15T23:17:33.813Z","dependency_job_id":"d4893621-d779-4e2e-8373-d0e0d17a25c9","html_url":"https://github.com/gitxtui/docs","commit_stats":null,"previous_names":["gitxtui/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gitxtui/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitxtui%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitxtui%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitxtui%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitxtui%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gitxtui","download_url":"https://codeload.github.com/gitxtui/docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitxtui%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29153417,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T02:39:25.012Z","status":"ssl_error","status_checked_at":"2026-02-06T02:37:22.784Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["cli","docsy","git","hacktoberfest","hacktoberfest2025","hugo","learning","tui","vcs"],"created_at":"2026-02-06T06:15:07.723Z","updated_at":"2026-02-06T06:15:08.271Z","avatar_url":"https://github.com/gitxtui.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docsy Example\n\n[Docsy][] is a [Hugo theme module][] for technical documentation sites, providing easy\nsite navigation, structure, and more. This **Docsy Example Project** uses the Docsy\ntheme component as a hugo module and provides a skeleton documentation structure for you to use.\nYou can clone/copy this project and 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 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. Use the dropdown for switching branches/tags to change to the **latest** released tag.\n\n2. Click **Use this template**.\n\n3. Select a name for your new project and click **Create repository from template**.\n\n4. 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 --depth 1 https://github.com/me/example.git\n```\n\nDepending on your environment you may need to adjust the top-level `module` settings in your project's Hugo config file, for example, by adding a proxy to use when downloading remote modules.\nYou can find details of what these configuration settings do in the [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 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```bash\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```bash\ndocker-compose rm\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 project. The newly created repo should now reside in a sibling folder of your site'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 `local` when using npm), the server now watches all files and directories inside the sibling directory `../docsy` , too. Any changes inside the local `docsy` theme clone are  now immediately picked up (hot reload), you can instantly see the effect of your local edits.\n\nIn the command above, we used the environment variable `HUGO_MODULE_WORKSPACE` to tell hugo about the local workspace file `docsy.work`. Alternatively, you can declare 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 workspace assignment is commented out, however. Remove the two trailing comment characters '//' 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 theme version `v0.12.0`, hugo version `0.146.0` or higher is required.\nSee this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo) of 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.\nSee this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo) of 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 system.\nSee this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-go-language) of the user guide for instructions on how to install `go`.\n\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]: 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitxtui%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitxtui%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitxtui%2Fdocs/lists"}