mirror of
https://github.com/flutter/samples.git
synced 2026-03-23 12:51:57 +00:00
36e7a6ab04
## Pre-launch Checklist - [x] I read the [Flutter Style Guide] _recently_, and have followed its advice. - [x] I signed the [CLA]. - [x] I read the [Contributors Guide]. - [x] I updated/added relevant documentation (doc comments with `///`). - [ ] All existing and new tests are passing. --------- Co-authored-by: David Iglesias <ditman@gmail.com> Co-authored-by: Mark Thompson <2554588+MarkTechson@users.noreply.github.com> Co-authored-by: John Ryan <ryjohn@google.com>
Flutter samples index generator
This tool is used to generate the visual samples index for Flutter samples.
Generating the index
We use grinder to run the build tasks:
$ 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:
$ dart pub global activate grinder
$ webdev serve
Publishing the index
You can build the complete index into a publishable directory using Grinder:
$ dart run grinder build-release
This outputs the completely built index to ./public.
Generating cookbook content
The cookbook articles are generated using a WebDriver script that scrapes the docs.flutter.dev website. To run:
- Install ChromeDriver
- run
chromedriver --port=4444 --url-base=wd/hub --verbose - run
dart run grinder scrape-cookbook