History

Simon Binder 137a7b00a0 Merge branch 'documentation-snippets' into develop		2022-03-01 20:43:20 +01:00
..
assets/path_provider	Extract snippets for documentation	2022-02-13 16:55:57 +01:00
lib	Update many-to-many example	2022-02-21 20:41:47 +01:00
pages	Merge branch 'documentation-snippets' into develop	2022-03-01 20:43:20 +01:00
templates	Extract snippets for documentation	2022-02-13 16:55:57 +01:00
tool	Use sqlparser for drift snippets	2022-02-14 22:13:00 +01:00
web	Add Flutter favorite icon to website	2021-12-09 00:21:57 +01:00
README.md	Update storage_inspector in community tools	2022-02-02 17:19:59 +01:00
build.deploy.yaml	Fix docs build script	2022-02-14 22:52:37 +01:00
build.yaml	Use sqlparser for drift snippets	2022-02-14 22:13:00 +01:00
pubspec.yaml	Update many-to-many example	2022-02-21 20:41:47 +01:00
theme.yaml	Add search to documentation	2021-08-09 18:32:09 +02:00
website.yaml	Docs: Suggest editing state from `develop`	2022-02-11 23:13:48 +01:00

README.md

Drift documentation

Welcome to the source of drift's documentation, live at drift.simonbinder.eu. We use a static site generator based on build_runner to build the documentation.

Running the website locally

For a fast edit-refresh cycle, run

dart pub global run webdev serve --auto refresh pages:9999 web:8080

You can ignore the pages:9999 (or use any other port), it's just required so that the build system actually generates pages.

Building the website

To build the website, first run

dart run build_runner build --release

To then copy generated contents into a directory, use:

dart run build_runner build --release --output web:out

Where out is the desired output directory. Note that both steps are necessary since the build system doesn't re-generate pages otherwise.