History

Simon Binder 02b7d30403 Document special syntax in create table statements		2022-09-20 21:48:23 +02:00
..
assets/path_provider	Extract snippets for documentation	2022-02-13 16:55:57 +01:00
lib	Format docs snippets	2022-08-27 21:44:42 +02:00
pages	Document special syntax in create table statements	2022-09-20 21:48:23 +02:00
templates	Collect documentation for 2.0 release	2022-08-13 14:18:17 +02:00
test	Move snippet test to docs package	2022-08-15 19:55:06 +02:00
tool	Delete old moor packages	2022-08-14 22:57:37 +02:00
web	Add Flutter favorite icon to website	2021-12-09 00:21:57 +01:00
README.md	Update docs on joins	2022-08-27 00:05:27 +02:00
analysis_options.yaml	Migrate to `package:lints`	2022-08-13 23:33:05 +02:00
build.yaml	Move snippet test to docs package	2022-08-15 19:55:06 +02:00
pubspec.yaml	Use melos to manage packages (#2060 )	2022-09-15 23:42:20 +02:00
theme.yaml	Add search to documentation	2021-08-09 18:32:09 +02:00
website.yaml	Replace old website and repository links	2022-03-13 15:52:15 +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 test:10000 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.