History

Simon Binder 40a1c91e25 Host api docs on moor website		2021-08-07 12:18:08 +02:00
..
lib	Upgrade dependencies in docs	2021-07-08 12:28:52 +02:00
pages	Add disclaimer to web workers section	2021-07-30 15:33:30 +02:00
templates	Upgrade dependencies in docs	2021-07-08 12:28:52 +02:00
tool	Host api docs on moor website	2021-08-07 12:18:08 +02:00
web/v2	Upgrade dependencies in docs	2021-07-08 12:28:52 +02:00
README.md	Upgrade dependencies in docs	2021-07-08 12:28:52 +02:00
build.deploy.yaml	Upgrade dependencies in docs	2021-07-08 12:28:52 +02:00
build.yaml	Upgrade dependencies in docs	2021-07-08 12:28:52 +02:00
pubspec.yaml	Upgrade dependencies in docs	2021-07-08 12:28:52 +02:00
theme.yaml	Upgrade dependencies in docs	2021-07-08 12:28:52 +02:00
website.yaml	Host api docs on moor website	2021-08-07 12:18:08 +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.