History

Simon Binder f510f3e5c3 Docs: Update built_site		2022-06-07 19:28:31 +02:00
..
assets/path_provider	Extract snippets for documentation	2022-02-13 16:55:57 +01:00
lib	Docs: Describe how to export databases (#376 )	2022-05-28 13:52:18 +02:00
pages	Also describe how to import backups	2022-05-28 13:57:56 +02:00
templates	Extract snippets for documentation	2022-02-13 16:55:57 +01:00
tool	Use dartdoc package in docs website	2022-05-13 11:58:27 +02: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	Use dartdoc package in docs website	2022-05-13 11:58:27 +02:00
build.yaml	Use dartdoc package in docs website	2022-05-13 11:58:27 +02:00
dartdoc.build.yaml	Use dartdoc package in docs website	2022-05-13 11:58:27 +02:00
pubspec.yaml	Docs: Update built_site	2022-06-07 19:28:31 +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 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.