History

Simon Binder ab8df5b270 Document custom row classes for moor files		2021-05-14 20:39:32 +02:00
..
lib	Use build_runner to generate documentation	2021-03-12 21:14:45 +01:00
pages	Document custom row classes for moor files	2021-05-14 20:39:32 +02:00
templates	Bring back 404 page	2021-03-19 21:11:12 +01:00
tool	Fix more dead links	2021-03-13 23:51:31 +01:00
web	Use build_runner to generate documentation	2021-03-12 21:14:45 +01:00
README.md	Use build_runner to generate documentation	2021-03-12 21:14:45 +01:00
build.deploy.yaml	Add site environment for previews	2021-03-12 23:16:48 +01:00
build.yaml	Add site environment for previews	2021-03-12 23:16:48 +01:00
pubspec.yaml	Adopt minimum SDK version, fix docs on mobile	2021-03-19 20:35:08 +01:00
website.yaml	Adopt minimum SDK version, fix docs on mobile	2021-03-19 20:35:08 +01: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 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.