expressive-code-fullscreen
Version:
Add fullscreen functionality to codeblocks in your documentation website.
53 lines (35 loc) • 1.95 kB
Markdown
<div align="center">
<h1>Expressive Code Fullscreen</h1>
<p>A plugin for Expressive Code that adds fullscreen viewing capabilities to code blocks with customizable themes and accessibility features.</p>
[](https://badge.fury.io/js/expressive-code-fullscreen)
[](https://opensource.org/licenses/MIT)
</div>
## Features
- **Fullscreen Mode**: Toggle code blocks to fullscreen view for better readability
- **Font Size Controls**: Adjust text size within fullscreen mode
- **Keyboard Navigation**: Exit fullscreen with Escape key or browser back button
- **Smart Targeting**: Choose to add buttons to all blocks or only titled ones
- **Customizable Theming**: Extensive theme customization options
## Installation
Install the plugin using your preferred package manager:
```bash
npm install expressive-code-fullscreen
```
## Quick Start
```js
import { pluginFullscreen } from 'expressive-code-fullscreen';
// Add to your Expressive Code configuration
plugins: [pluginFullscreen()]
```
## Documentation
For comprehensive documentation, installation guides, configuration options, and examples, visit the [plugin documentation](https://frostybee.github.io/expressive-code-fullscreen/).
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
## License
Licensed under the MIT License, Copyright © frostybee.
See [LICENSE](/LICENSE) for more information.
## Links
- [GitHub Repository](https://github.com/frostybee/expressive-code-fullscreen)
- [npm Package](https://www.npmjs.com/package/expressive-code-fullscreen)
- [Documentation](https://frostybee.github.io/expressive-code-fullscreen/)
- [Issues](https://github.com/frostybee/expressive-code-fullscreen/issues)