Merge branch 'master' into image-zoom

Author: HarshCasper

astro.config.mjs

@@ -5,6 +5,9 @@ import starlightUtils from '@lorenzo_lewis/starlight-utils';
 import starlightDocSearch from '@astrojs/starlight-docsearch';
 import starlightLinksValidator from 'starlight-links-validator'
 import starlightImageZoom from 'starlight-image-zoom'
+import sitemap from '@astrojs/sitemap';
+import starlightFullViewMode from 'starlight-fullview-mode'
+import starlightTocOverviewCustomizer from 'starlight-toc-overview-customizer'
 
 import markdoc from '@astrojs/markdoc';
 
@@ -24,6 +27,7 @@ const latestVersion = data.tag_name.replace('v', '');
 
 // https://astro.build/config
 export default defineConfig({
+  site: 'https://docs.localstack.cloud',
   env: {
     schema: {
       LOCALSTACK_VERSION: envField.string({
@@ -40,10 +44,20 @@ export default defineConfig({
       title: 'Docs',
       favicon: '/images/favicons/favicon.ico',
       customCss: ['./src/styles/global.css'],
+      editLink: {
+        baseUrl: 'https://github.com/localstack/localstack-docs/edit/master/',
+      },
       components: {
         PageTitle: './src/components/PageTitleWithBadges.astro',
       },
       head: [
+        {
+          tag: 'link',
+          attrs: {
+            rel: 'sitemap',
+            href: '/sitemap-index.xml',
+          },
+        },
         {
           tag: 'script',
           content: `!function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.crossOrigin="anonymous",p.async=!0,p.src=s.api_host.replace(".i.posthog.com","-assets.i.posthog.com")+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="init capture register register_once register_for_session unregister unregister_for_session getFeatureFlag getFeatureFlagPayload isFeatureEnabled reloadFeatureFlags updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures on onFeatureFlags onSessionId getSurveys getActiveMatchingSurveys renderSurvey canRenderSurvey identify setPersonProperties group resetGroups setPersonPropertiesForFlags resetPersonPropertiesForFlags setGroupPropertiesForFlags resetGroupPropertiesForFlags reset get_distinct_id getGroups get_session_id get_session_replay_url alias set_config startSessionRecording stopSessionRecording sessionRecordingStarted captureException loadToolbar get_property getSessionProperty createPersonProfile opt_in_capturing opt_out_capturing has_opted_in_capturing has_opted_out_capturing clear_opt_in_out_capturing debug getPageViewId captureTraceFeedback captureTraceMetric".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]); posthog.init('phc_6bea9iRqN9iwiwf5aM3dVXrKmAQGGMahouBRMIyQfnE', { api_host: 'https://us.i.posthog.com', person_profiles: 'always' });`,
@@ -98,6 +112,12 @@ export default defineConfig({
         starlightImageZoom({
           showCaptions: true,
         }),
+        starlightTocOverviewCustomizer({
+          overviewTitle: "Back to top",
+        }),
+        starlightFullViewMode({
+          leftSidebarEnabled: false,
+        }),
         starlightLinksValidator({
           errorOnRelativeLinks: false,
           errorOnLocalLinks: false,
@@ -407,6 +427,7 @@ export default defineConfig({
     }),
     markdoc(),
     react(),
+    sitemap(),
   ],
 
   vite: {

package-lock.json

@@ -12,6 +12,7 @@
   "dependencies": {
     "@astrojs/markdoc": "^0.14.2",
     "@astrojs/react": "^4.2.7",
+    "@astrojs/sitemap": "^3.4.1",
     "@astrojs/starlight": "^0.34.0",
     "@astrojs/starlight-docsearch": "^0.6.0",
     "@astrojs/starlight-markdoc": "^0.4.0",
@@ -30,7 +31,9 @@
     "react-dom": "^19.1.0",
     "sharp": "^0.32.5",
     "starlight-image-zoom": "^0.12.0",
+    "starlight-fullview-mode": "^0.2.3",
     "starlight-links-validator": "^0.17.0",
+    "starlight-toc-overview-customizer": "^0.1.0",
     "tailwind-merge": "^3.2.0",
     "tailwindcss": "^4.1.6"
   },

package.json

@@ -0,0 +1,4 @@
+User-agent: *
+Allow: /
+
+Sitemap: https://docs.localstack.cloud/sitemap-index.xml 

public/robots.txt

@@ -49,7 +49,7 @@ When active, rules are evaluated sequentially on every request to LocalStack unt
 
 The schema for the configuration is as follows.
 
-```json
+```json showshowLineNumbers
 [
     {
         "region": "(str) Region name, e.g. 'ap-south-1'. If omitted, all regions are affected.",

src/content/docs/aws/capabilities/chaos-engineering/chaos-api.md

@@ -101,7 +101,7 @@ podman machine set --rootful
 For the Docker Compose setup, use the following configuration.
 When running in rootless mode, ensure to comment out the HTTPS gateway port, as it is unable to bind to privileged ports below 1024.
 
-```yaml
+```yaml showshowLineNumbers
 services:
   localstack:
     container_name: "${LOCALSTACK_DOCKER_NAME:-localstack-main}"

src/content/docs/aws/capabilities/config/podman.md

@@ -2,6 +2,7 @@
 title: Capabilities 
 description: This section describes the capabilities of LocalStack, that go beyond the core cloud service emulation, and provide additional features and capabilities for LocalStack users.
 template: doc
+editUrl: false
 sidebar:
     order: 5
 ---

src/content/docs/aws/capabilities/index.mdx

@@ -130,7 +130,7 @@ docker run --rm -it --dns 172.27.0.2 --network ls <arguments> <image name>
 ```
 </TabItem>
 <TabItem label="docker-compose.yml">
-```yaml
+```yaml showshowLineNumbers
 services:
   localstack:
     container_name: "${LOCALSTACK_DOCKER_NAME:-localstack-main}"
@@ -200,7 +200,7 @@ docker run --rm it --network my-network <image name>
 ```
 </TabItem>
 <TabItem label="docker-compose.yml">
-```yaml
+```yaml showshowLineNumbers
 services:
   localstack:
     # other configuration here

src/content/docs/aws/capabilities/networking/accessing-endpoint-url.mdx

@@ -52,7 +52,7 @@ GATEWAY_LISTEN=0.0.0.0:4766 EXTERNAL_SERVICE_PORTS_START=4710 EXTERNAL_SERVICE_P
 ```
   </TabItem>
   <TabItem label="docker-compose">
-```yaml
+```yaml showshowLineNumbers
 services:
   localstack-main-1:
     container_name: localstack-main-1

src/content/docs/aws/capabilities/networking/external-port-range.mdx

@@ -34,7 +34,7 @@ If you run LocalStack in a docker container (which includes using [the CLI](/aws
 
 Create a `Dockerfile` containing the following commands:
 
-```yaml
+```yaml showshowLineNumbers
 FROM localstack/localstack:latest
 # or if using the pro image:
 FROM localstack/localstack-pro:latest
@@ -74,7 +74,7 @@ docker run <docker arguments> <image name>
 ```
 </TabItem>
 <TabItem label="docker-compose.yml">
-```yaml
+```yaml showshowLineNumbers
 services:
   localstack:
     image: <image name>