https://github.com/btwld/superdeck
Presentation slides for Flutter with Flutter
https://github.com/btwld/superdeck
Last synced: 4 months ago
JSON representation
Presentation slides for Flutter with Flutter
- Host: GitHub
- URL: https://github.com/btwld/superdeck
- Owner: btwld
- License: bsd-3-clause
- Created: 2022-05-25T13:38:29.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2026-02-13T22:25:13.000Z (4 months ago)
- Last Synced: 2026-02-14T03:38:27.670Z (4 months ago)
- Language: Dart
- Size: 77.7 MB
- Stars: 119
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# SuperDeck
SuperDeck is a Flutter presentation framework. You write slides in Markdown, and SuperDeck renders them with Flutter.
- Live demo: https://superdeck-dev.web.app
- Example deck: `demo/slides.md`
- Documentation (in this repo): `docs/`
## Quickstart
1. Install the CLI:
```bash
dart pub global activate superdeck_cli
```
2. In your Flutter project, run setup and add the package:
```bash
cd your_flutter_project
superdeck setup
flutter pub add superdeck
```
3. Initialize SuperDeck in `lib/main.dart`:
```dart
import 'package:flutter/widgets.dart';
import 'package:superdeck/superdeck.dart';
Future main() async {
WidgetsFlutterBinding.ensureInitialized();
await SuperDeckApp.initialize();
runApp(const SuperDeckApp(options: DeckOptions()));
}
```
4. Build slides and run the app:
```bash
superdeck build --watch
flutter run
```
## Write slides
Create a `slides.md` file in your project root. Separate slides with `---`.
```md
---
@column
# Welcome
@column
- Write slides in Markdown
- Use blocks for layout
---
```
## Learn more
- `docs/getting-started.mdx`
- `docs/guides/cli-reference.mdx`
- `docs/reference/block-types.mdx`
- `docs/reference/deck-options.mdx`
## Contributing
SuperDeck is a Melos workspace pinned to Flutter stable via FVM.
```bash
fvm use stable --force
dart pub global activate melos
melos bootstrap
melos run analyze
melos run test
```