1
0
mirror of https://github.com/flutter/samples.git synced 2025-11-08 22:09:06 +00:00
Files
samples/web/samples_index/README.md
Parker Lougheed ab6d874404 Simplify samples index and remove cookbook recipes (#2102)
Remove the cookbook recipes from the samples index in a step to
eventually remove it as a whole.

The cookbook recipe listings in the index haven't been updated in a long
time, the support for updating them doesn't work, and this isn't
generally how people are finding cookbook recipes.

This has the added benefit of reducing repo size quite a bit due to the
large images.
2023-11-30 12:17:19 -06:00

36 lines
744 B
Markdown

# Flutter samples index generator
This tool is used to generate the visual
[samples index for Flutter samples](https://flutter.github.io/samples/).
## Generating the index
We use [grinder](https://pub.dev/packages/grinder) to run the build tasks:
```bash
$ dart pub get
$ dart run grinder generate
```
This will generate the index into `./web`
## Serving the index locally
If you want to serve the index locally, you can use
[webdev](https://pub.dev/packages/webdev):
```bash
$ dart pub global activate grinder
$ webdev serve
```
## Publishing the index
You can build the complete index into a publishable directory using Grinder:
```bash
$ dart run grinder build-release
```
This outputs the completely built index to `./public`.