@@ -7,14 +7,20 @@ content and code in this repository.
77## Project overview
88
99This repository contains the source code and content for
10- the Flutter framework's documentation website.
11- It is hosted at ` docs.flutter.dev ` and shouldn't be confused with
12- the marketing site at ` flutter.dev ` or the API docs at ` api.flutter.dev ` .
10+ the Flutter framework's documentation and marketing websites:
1311
14- The website is statically built and implemented with
12+ - ` docs.flutter.dev ` :
13+ The Flutter framework's documentation website.
14+ - ` flutter.dev ` :
15+ Flutter's homepage and marketing website.
16+
17+ The API docs at ` api.flutter.dev ` are embedded in the Flutter SDK source
18+ and are maintained in the < https://github.com/flutter/flutter > repository.
19+
20+ The websites are statically built and implemented with
1521Dart and the [ Jaspr] ( https://jaspr.site ) web framework.
16- For loading content, data, and some of its assets,
17- it uses [ Jaspr Content] ( https://docs.jaspr.site/content ) .
22+ For loading content, data, and some assets,
23+ they use [ Jaspr Content] ( https://docs.jaspr.site/content ) .
1824
1925### Directory structure
2026
@@ -30,29 +36,40 @@ it uses [Jaspr Content](https://docs.jaspr.site/content).
3036 for the sidenav, glossary, and various indices.
3137 - ` sites/docs/src/_includes/ ` :
3238 Liquid partial files written in Markdown.
39+ - ` sites/www/ ` :
40+ The implementation of flutter.dev,
41+ written in Dart using Jaspr and Jaspr Content.
42+ - ` sites/www/content/ ` :
43+ Markdown-based marketing pages and structured content.
44+ - ` sites/www/lib/ ` :
45+ Dart source code for the site.
46+ - ` sites/www/firebase.json ` :
47+ Firebase Hosting configuration for flutter.dev.
3348- ` examples/ ` :
3449 A pub workspace containing Dart and Flutter code examples,
35- referenced by code excerpts in the Markdown files.
50+ referenced by code excerpts in the docs Markdown files.
3651- ` tool/dash_site/ ` :
3752 CLI tool for site development and maintenance.
3853
3954## Common commands
4055
41- While working on the site ,
56+ While working on these sites ,
4257you might need to run these commands:
4358
4459``` bash
4560# Install or update Dart dependencies:
4661dart pub get
4762
4863# Serve a dev server of the site locally:
49- dart run dash_site serve
64+ dart run dash_site --site=docs serve
65+ dart run dash_site --site=www serve
5066
5167# Build a production version of the site:
52- dart run dash_site build
68+ dart run dash_site --site=docs build
69+ dart run dash_site --site=www build
5370
54- # Sync code excerpts to Markdown files:
55- dart run dash_site refresh-excerpts
71+ # Sync docs code excerpts to Markdown files:
72+ dart run dash_site --site=docs refresh-excerpts
5673
5774# Learn what other commands are available:
5875dart run dash_site --help
0 commit comments