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/README.md

44 lines
1.0 KiB

# Flutter samples index generator
This tool is used to generate the visual samples index for Flutter 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`.
## Generating cookbook content
The cookbook articles are generated using a WebDriver script
that scrapes the docs.flutter.dev website. To run:
1. Install [ChromeDriver](https://chromedriver.chromium.org/downloads)
2. run `chromedriver --port=4444 --url-base=wd/hub --verbose`
3. run `dart run grinder scrape-cookbook`