{"id":19571974,"url":"https://github.com/getsops/docs","last_synced_at":"2025-02-26T10:43:46.066Z","repository":{"id":226319214,"uuid":"763725114","full_name":"getsops/docs","owner":"getsops","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-17T14:09:48.000Z","size":999,"stargazers_count":4,"open_issues_count":3,"forks_count":7,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-02-17T15:24:06.150Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getsops.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":"2024-02-26T20:06:49.000Z","updated_at":"2025-02-17T14:09:53.000Z","dependencies_parsed_at":"2025-02-17T15:32:20.273Z","dependency_job_id":null,"html_url":"https://github.com/getsops/docs","commit_stats":null,"previous_names":["getsops/docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getsops%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getsops%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getsops%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getsops%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getsops","download_url":"https://codeload.github.com/getsops/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240840037,"owners_count":19866164,"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":[],"created_at":"2024-11-11T06:22:23.940Z","updated_at":"2025-02-26T10:43:46.013Z","avatar_url":"https://github.com/getsops.png","language":"SCSS","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\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```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.7.2 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.7.0`, hugo version `0.110.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 you have not installed the `go` programming language 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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetsops%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetsops%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetsops%2Fdocs/lists"}