History

Simon Binder 0563a7fa15 Fix link check, again		2022-01-07 23:06:23 +01:00
..
lib	Add Flutter favorite icon to website	2021-12-09 00:21:57 +01:00
pages	Fix missing quotes in drift files docs	2022-01-05 18:52:35 +01:00
templates	Add Flutter favorite icon to website	2021-12-09 00:21:57 +01:00
tool	Fix link check, again	2022-01-07 23:06:23 +01:00
web	Add Flutter favorite icon to website	2021-12-09 00:21:57 +01:00
README.md	Upgrade dependencies in docs	2021-07-08 12:28:52 +02:00
build.deploy.yaml	Fix typo in prod build config	2021-10-12 15:17:40 +02:00
build.yaml	Start preparing the documentation for the new name	2021-10-09 21:43:30 +02:00
pubspec.yaml	Use Dart-based linkcheck	2021-12-21 19:54:54 +01:00
theme.yaml	Add search to documentation	2021-08-09 18:32:09 +02:00
website.yaml	Prepare moor 4.6.0 release	2021-10-12 14:26:53 +02:00

README.md

Moor documentation

Welcome to the source of moor's documentation, live at moor.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.