You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
samples/web/samples_index
Brett Morgan 82e38e5b79
Update samples for Dart 3.0.0 (#1803)
2 years ago
..
lib Add web_embedding sample to sample index (#1801) 2 years ago
test Implement case insensitive search in the samples index (#1518) 2 years ago
tool Minor sample index cleanup (#1532) 2 years ago
web Add web_embedding sample to sample index (#1801) 2 years ago
.gitignore Minor sample index cleanup (#1532) 2 years ago
CHANGELOG.md Add samples index (#359) 5 years ago
README.md Update README.md (#1707) 2 years ago
analysis_options.yaml Minor sample index cleanup (#1532) 2 years ago
pubspec.yaml Update samples for Dart 3.0.0 (#1803) 2 years ago

README.md

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:

  1. Install ChromeDriver
  2. run chromedriver --port=4444 --url-base=wd/hub --verbose
  3. run dart run grinder scrape-cookbook