{"id":18636729,"url":"https://github.com/localstack/docs","last_synced_at":"2025-11-04T14:30:26.005Z","repository":{"id":37570710,"uuid":"410815220","full_name":"localstack/docs","owner":"localstack","description":"The LocalStack documentation 📖","archived":false,"fork":false,"pushed_at":"2024-10-29T11:19:28.000Z","size":426265,"stargazers_count":60,"open_issues_count":39,"forks_count":109,"subscribers_count":17,"default_branch":"main","last_synced_at":"2024-10-29T11:36:43.541Z","etag":null,"topics":["documentation","localstack"],"latest_commit_sha":null,"homepage":"https://docs.localstack.cloud","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/localstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-27T09:08:19.000Z","updated_at":"2024-10-29T11:18:09.000Z","dependencies_parsed_at":"2023-10-30T09:35:41.405Z","dependency_job_id":"42ededfa-0797-4996-9bbe-6469d9e4ea8d","html_url":"https://github.com/localstack/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localstack%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/localstack","download_url":"https://codeload.github.com/localstack/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239433908,"owners_count":19637806,"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":["documentation","localstack"],"created_at":"2024-11-07T05:31:37.428Z","updated_at":"2025-11-04T14:30:25.957Z","avatar_url":"https://github.com/localstack.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# LocalStack Docs\n\nRepository for [docs.localstack.cloud](https://docs.localstack.cloud).\n\n## Getting Started\n\n### Basics\n\nLocalStack Docs is using the following technology stack:\n- [Hugo](https://gohugo.io) to generate the static site.\n- [Docsy](https://docsy.dev) as a theme for Hugo.\n- [GitHub Pages](https://pages.github.com/) to automatically deploy every commit on the `main` branch of this repository on [docs.localstack.cloud](https://docs.localstack.cloud).\n\n### Clone the repo\n\nClone this repository and initialize the Git submodules recursively (`themes/docsy` is a submodule that again has submodules for vendored assets like fontawesome).\n\n    git clone --recurse-submodules --depth 1 git@github.com:localstack/docs.git\n\nThis performs a shallow clone, which leads to only the main branch being configured for your remote.\nTo be able to pull/push from/to all branches, please run:\n\n    git config remote.origin.fetch \"+refs/heads/*:refs/remotes/origin/*\" \u0026\u0026 git fetch\n\nor:\n\n    git clone git@github.com:localstack/docs.git\n    cd docs\n    git submodule update --init --recursive\n\n### Install Hugo\n\nLocalStack Docs is based on the [Hugo static site generator](https://gohugo.io).\n\nIn order to contribute to LocalStack Docs, you need to [install Hugo](https://gohugo.io/getting-started/installing) in order to verify your changes.\nMake sure to install the _extended_ version of Hugo.\nYou also need to make sure that `go` is installed in order to run hugo scripts.\n\n### Run locally\n\nOnce you have Hugo installed, you can start your local server with the following command:\n\n    hugo serve\n\nor run in developer mode with automatic reload:\n\n    hugo serve --watch=true --disableFastRender -D\n\nOnce the server is started, the locally served Docs are available at http://localhost:1313.\n\n### Writing content\n\nThe whole site is generated with Hugo, a powerful static-site generator.\n\nYou can find an extensive documentation on how to use Hugo [in their docs](https://gohugo.io/documentation/), however most of the content is written in plain Markdown.\n\nMake sure to follow the best practices below when contributing content.\n\n#### Updating developer hub applications\n\nWhile contributing to the developer hub applications page i.e. editing `data/developerhub/applications.json` file, make sure to run the `create-applications.js` script in the `scripts` folder to create new application pages.\n\nExample usage in the project root:\n\n    node scripts/create-applications.js\n\n### Running pre-commit checks\n\nYou can run pre-commit checks to ensure that your changes are compliant with the repository's standards.\n\n```bash\npip install pre-commit\npre-commit install\n```\n\npre-commit will run automatically before each commit.\nIf you want to run it manually, use `pre-commit run`.\n\n## Best Practices\n\nPlease follow these best practices when writing documentation in this repository:\n- **Stick to markdown** wherever possible.\n- **One sentence per line:** Use one line for each sentence in markdown.\n  Unless you add a backslash at the end of the line or add two new-lines, there won't be linebreak in the rendered text.\n- **Commands:** Use the `command` shortcode for all one-line commands (also when their output is presented).\n  Do not use it for bash scripts with comments.\n  You can find a more detailed description here: https://github.com/localstack/docs/pull/55.\n  If needed, you can also [highlight a specific line](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences).\n- **Internal links:** Use the [`ref` or `relref` shortcode](https://gohugo.io/content-management/cross-references/#use-ref-and-relref) when creating non-external links (but still use the markdown native image linking, ref doesn't work there).\n  You can either use `ref` or `relref`, the point is to have compile time internal-link checks (which works for both).\n- **Code snippets:** For snippets, make sure you indicate the programming/markup language so that proper syntax highlighting is used.\n  Use `bash` only for Bash scripts, and use `text` for shell outputs or command examples.\n  The full list of the supported languages [here](https://gohugo.io/content-management/syntax-highlighting/).\n  If needed, you can also [highlight a specific line](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences) in the snippet.\n- **Images:** If you want to use images in your post, create a new [leaf bundle directory](https://github.com/gohugoio/hugo/issues/1240) and put the image and the post (named `index.md`) in there (you can find examples in the docs already, f.e.\n  the cognito service docs).\n  Then you can use the usual markdown syntax with a relative path (f.e.: `![Alternative_Text](file_next_to_post.png)`).\n  If you want to resize the image, use the `figure` or `img` shortcode, for example: `{{\u003c img src=\"cockpit-init-check.png\" class=\"img-fluid shadow rounded\" width=\"150px\" \u003e}}`\n- **Callouts:** Use these to make content stand out.\n  The `callout` shortcode supports `note` (default), `tip` and `warning` levels.\n  Use it like so:\n\n  ```markdown\n  {{\u003c callout \"warning\" \u003e}}\n  This will make your computer halt and catch fire!\n  {{\u003c /callout \u003e}}\n  ```\n\n## Troubleshooting\n\nThis section covers common issues when working with LocalStack Docs:\n\n### Missing shortcodes\n\nExample error:\n\n```bash\nStart building sites …\nhugo v0.88.1-5BC54738+extended linux/amd64 BuildDate=2021-09-04T09:39:19Z VendorInfo=gohugoio\nError: Error building site: \"/home/localstack/Repos/docs-test/content/en/get-started/_index.md:57:1\": failed to extract shortcode: template for shortcode \"alert\" not found\nBuilt in 45 ms\n```\n\n1. Make sure to correctly clone and initialize the git submodules of this repo.\n  For details see the section \"[Clone the repo](#clone-the-repo)\" above.\n2. Delete the Hugo Module cache using `hugo mod clean` or `make clean`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalstack%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flocalstack%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalstack%2Fdocs/lists"}