https://github.com/windmillcode/starlight-fullview-mode
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.
https://github.com/windmillcode/starlight-fullview-mode
astro fullscreen fullscreen-mode starlight starlight-astro starlight-plugin starlight-view-modes view-modes
Last synced: 8 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/windmillcode/starlight-fullview-mode
- Owner: WindMillCode
- License: mit
- Created: 2025-04-05T16:14:59.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2025-04-27T14:22:08.000Z (9 days ago)
- Last Synced: 2025-04-27T15:27:04.473Z (9 days ago)
- Topics: astro, fullscreen, fullscreen-mode, starlight, starlight-astro, starlight-plugin, starlight-view-modes, view-modes
- Language: Astro
- Homepage: https://windmillcode.github.io/starlight-fullview-mode/
- Size: 1.51 MB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Starlight Fullview Mode
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. [Learn more](https://windmillcode.github.io/starlight-fullview-mode/getting-started/)
## License
Licensed under the MIT License, Copyright © Windmillcode.
See [LICENSE](https://github.com/Windmillcode/starlight-fullview-mode/blob/main/LICENSE) for more information.
Prerequisites
-------------
You 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.
Installation
------------
1. `starlight-fullview-mode` is a Starlight [plugin](https://starlight.astro.build/reference/plugins/). Install it by running the following command in your terminal:
NPM
npm install starlight-fullview-mode
PNPM
pnpm add starlight-fullview-mode
YARN
yarn add starlight-fullview-mode
2. Configure the plugin in your Starlight [configuration](https://starlight.astro.build/reference/configuration/#plugins) in the `astro.config.mjs` file.
```js
import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import starlightFullViewMode from 'starlight-fullview-mode'
export default defineConfig({
integrations: [
starlight({
plugins: [
starlightFullViewMode({
// Configuration options go here.
})
],
title: 'My Docs',
}),
],
})
```
Configuration
-------------
The plugin accepts the following configuration options:
### `leftSidebarEnabled`
* **Type:** `boolean`
* **Default:** `true`
* **Description:** Controls whether the left sidebar can be toggled between collapsed and expanded states.
### `rightSidebarEnabled`
* **Type:** `boolean`
* **Default:** `true`
* **Description:** Controls whether the right sidebar (table of contents) can be toggled between collapsed and expanded states.
#### Examples
Enable the left sidebar and disable the right sidebar:
starlightFullViewMode({ leftSidebarEnabled: true, rightSidebarEnabled: false})
Enable the right sidebar and disable the left sidebar:
starlightFullViewMode({ leftSidebarEnabled: false, rightSidebarEnabled: true})