{"id":27736726,"url":"https://github.com/windmillcode/starlight-fullview-mode","last_synced_at":"2025-04-28T14:29:47.803Z","repository":{"id":286316569,"uuid":"961040417","full_name":"WindMillCode/starlight-fullview-mode","owner":"WindMillCode","description":"A minimalist plugin that collapses Starlight's sidebars and expands the main content to full width, creating a distraction-free, fullscreen-like reading experience. Toggle with a single click to focus purely on your content.","archived":false,"fork":false,"pushed_at":"2025-04-27T14:22:08.000Z","size":1580,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-27T15:27:04.473Z","etag":null,"topics":["astro","fullscreen","fullscreen-mode","starlight","starlight-astro","starlight-plugin","starlight-view-modes","view-modes"],"latest_commit_sha":null,"homepage":"https://windmillcode.github.io/starlight-fullview-mode/","language":"Astro","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WindMillCode.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-04-05T16:14:59.000Z","updated_at":"2025-04-27T14:22:12.000Z","dependencies_parsed_at":"2025-04-06T03:41:24.779Z","dependency_job_id":null,"html_url":"https://github.com/WindMillCode/starlight-fullview-mode","commit_stats":null,"previous_names":["windmillcode/starlight-full-view-mode","windmillcode/starlight-fullview-mode"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindMillCode%2Fstarlight-fullview-mode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindMillCode%2Fstarlight-fullview-mode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindMillCode%2Fstarlight-fullview-mode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindMillCode%2Fstarlight-fullview-mode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WindMillCode","download_url":"https://codeload.github.com/WindMillCode/starlight-fullview-mode/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251329950,"owners_count":21572211,"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":["astro","fullscreen","fullscreen-mode","starlight","starlight-astro","starlight-plugin","starlight-view-modes","view-modes"],"created_at":"2025-04-28T14:29:47.196Z","updated_at":"2025-04-28T14:29:47.768Z","avatar_url":"https://github.com/WindMillCode.png","language":"Astro","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Starlight Fullview Mode\n\nA minimalist plugin that collapses Starlight\u0026#39;s sidebars and expands the main content to full width, creating a distraction-free, fullscreen-like reading experience. Toggle with a single click to focus purely on your content. [Learn more](https://windmillcode.github.io/starlight-fullview-mode/getting-started/)\n\n\n## License\n\nLicensed under the MIT License, Copyright © Windmillcode.\n\nSee [LICENSE](https://github.com/Windmillcode/starlight-fullview-mode/blob/main/LICENSE) for more information.\n\nPrerequisites\n-------------\n\nYou will need to have a Starlight website set up. If you don’t have one yet, you can follow the [“Getting Started”](https://starlight.astro.build/getting-started) guide in the Starlight docs to create one.\n\nInstallation\n------------\n\n1.  `starlight-fullview-mode` is a Starlight [plugin](https://starlight.astro.build/reference/plugins/). Install it by running the following command in your terminal:\n\n\n    NPM\n\n        npm install starlight-fullview-mode\n\n    PNPM\n\n        pnpm add starlight-fullview-mode\n\n    YARN\n\n        yarn add starlight-fullview-mode\n\n2.  Configure the plugin in your Starlight [configuration](https://starlight.astro.build/reference/configuration/#plugins) in the `astro.config.mjs` file.\n\n\n```js\nimport starlight from '@astrojs/starlight'\nimport { defineConfig } from 'astro/config'\nimport starlightFullViewMode from 'starlight-fullview-mode'\n\nexport default defineConfig({\n  integrations: [\n    starlight({\n      plugins: [\n        starlightFullViewMode({\n           // Configuration options go here.\n        })\n       ],\n      title: 'My Docs',\n    }),\n  ],\n})\n```\n\n\nConfiguration\n-------------\n\nThe plugin accepts the following configuration options:\n\n### `leftSidebarEnabled`\n\n*   **Type:** `boolean`\n*   **Default:** `true`\n*   **Description:** Controls whether the left sidebar can be toggled between collapsed and expanded states.\n\n### `rightSidebarEnabled`\n\n*   **Type:** `boolean`\n*   **Default:** `true`\n*   **Description:** Controls whether the right sidebar (table of contents) can be toggled between collapsed and expanded states.\n\n#### Examples\n\nEnable the left sidebar and disable the right sidebar:\n\n    starlightFullViewMode({  leftSidebarEnabled: true,  rightSidebarEnabled: false})\n\nEnable the right sidebar and disable the left sidebar:\n\n    starlightFullViewMode({  leftSidebarEnabled: false,  rightSidebarEnabled: true})\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindmillcode%2Fstarlight-fullview-mode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwindmillcode%2Fstarlight-fullview-mode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindmillcode%2Fstarlight-fullview-mode/lists"}