update deploy instructions in README

dimitri-yatsenko · dimitri-yatsenko · commit 44950ba322de · 2025-09-08T21:23:01.000Z
diff --git a/README.md b/README.md
@@ -20,3 +20,15 @@ We welcome and appreciate your contributions to this book, whether as a reviewer
 All contributions will be gratefully acknowledged.
 You may suggest modifications by submitting an issue in the main [GitHub repository](https://github.com/dimitri-yatsenko/datajoint-book) for this book.
 For more substrantial contributions and collaborations, including co-authorship and publications, please contact Dimitri Yatsenko.
+
+# Deployment
+
+The MyST static site deployment instructions are provided here: https://mystmd.org/guide/deployment
+
+Inside the devcontainer:
+
+```shell
+$ cd book
+$ myst build --html
+$ npx serve _build/html
+```
diff --git a/book/.gitignore b/book/.gitignore
@@ -1,2 +1,2 @@
 # MyST build outputs
-/_build/
+/_build/
diff --git a/book/myst.yml b/book/myst.yml
@@ -9,96 +9,91 @@ project:
   authors: Dimitri Yatsenko
   github: https://github.com/dimitri-yatsenko/datajoint-book
 
-exports: 
-  - format: html
-
-  # use implicit table of contents 
-  # To autogenerate a Table of Contents, run "myst init --write-toc"
-
-toc:
-# Auto-generated by `myst init --write-toc`
-- file: README.md
-- file: LICENSE.md
-- title: Introduction
-  children:
-	- file: 00-introduction/00-purpose.md
-	- file: 00-introduction/01-history.md
-- title: Setup
-  children:
-	- file: 10-setup/00-prerequisites.md
-	- file: 10-setup/01-environment.md
-	- file: 10-setup/02-connect.ipynb
-- title: Concepts
-  children:
-	- file: 20-concepts/00-models.md
-	- file: 20-concepts/01-relational.md
-	- file: 20-concepts/02-databases.md
-	- file: 20-concepts/04-integrity.md
-	- file: 20-concepts/05-queries.md
-- title: Schema Design
-  children:
-	- file: 30-schema-design/010-schema.ipynb
-	- file: 30-schema-design/010-table.ipynb
-	- file: 30-schema-design/015-default-values.ipynb
-	- file: 30-schema-design/020-lookup-tables.ipynb
-	- file: 30-schema-design/025-entity-integrity.md
-	- file: 30-schema-design/030-foreign-keys.ipynb
-	- file: 30-schema-design/035-diagrams.ipynb
-	- file: 30-schema-design/036-reverse-engineer.ipynb
-	- file: 30-schema-design/045-normalization.ipynb
-	- file: 30-schema-design/050-relationships.ipynb
-	- file: 30-schema-design/060-uuid.ipynb
-	- file: 30-schema-design/082-indexes.ipynb
-	- file: 30-schema-design/083-attach.ipynb
-	- file: 30-schema-design/084-filepath.ipynb
-	- file: 30-schema-design/086-adapted-types.ipynb
-	- file: 30-schema-design/091-alter.ipynb
-- title: Example Designs
-  children:
-	- file: 35-example-designs/000-example-designs.ipynb
-	- file: 35-example-designs/010-sales-database.ipynb
-	- file: 35-example-designs/015-university-database.ipynb
-	- file: 35-example-designs/030-nations-database.ipynb
-	- file: 35-example-designs/040-hotel-database.ipynb
-	- file: 35-example-designs/070-julia.ipynb
-- title: Manipulations
-  children:
-	- file: 40-manipulations/010-insert.ipynb
-	- file: 40-manipulations/020-delete.ipynb
-	- file: 40-manipulations/030-updates.ipynb
-	- file: 40-manipulations/040-transactions.ipynb
-	- file: 40-manipulations/80-caching.ipynb
-- title: Queries
-  children:
-	- file: 50-queries/005-fetch.ipynb
-	- file: 50-queries/010-operators.ipynb
-	- file: 50-queries/020-restriction.ipynb
-	- file: 50-queries/030-projection.ipynb
-	- file: 50-queries/040-join.ipynb
-	- file: 50-queries/050-union.ipynb
-	- file: 50-queries/060-universal.ipynb
-	- file: 50-queries/070-aggregation.ipynb
-- title: Computation
-  children:
-	- file: 60-computation/010-computation.ipynb
-- title: Interfaces
-  children:
-	- file: 70-interfaces/011-dashboard.ipynb
-- title: Exercises
-  children:
-	- file: 95-exercises/Assignment01.ipynb
-	- file: 95-exercises/Assignment02.ipynb
-	- file: 95-exercises/Assignment03.ipynb
-	- file: 95-exercises/Assignment04.ipynb
-	- file: 95-exercises/Assignment05.ipynb
-	- file: 95-exercises/Assignment06.ipynb
-	- file: 95-exercises/Assignment07.ipynb
-
+  toc:
+    # Auto-generated by `myst init --write-toc`
+    - file: README.md
+    - file: LICENSE.md
+    - title: Introduction
+      children:
+        - file: 00-introduction/00-purpose.md
+        - file: 00-introduction/01-history.md
+    - title: Setup
+      children:
+        - file: 10-setup/00-prerequisites.md
+        - file: 10-setup/01-environment.md
+        - file: 10-setup/02-connect.ipynb
+    - title: Concepts
+      children:
+        - file: 20-concepts/00-models.md
+        - file: 20-concepts/01-relational.md
+        - file: 20-concepts/02-databases.md
+        - file: 20-concepts/04-integrity.md
+        - file: 20-concepts/05-queries.md
+    - title: Schema Design
+      children:
+        - file: 30-schema-design/010-schema.ipynb
+        - file: 30-schema-design/010-table.ipynb
+        - file: 30-schema-design/015-default-values.ipynb
+        - file: 30-schema-design/020-lookup-tables.ipynb
+        - file: 30-schema-design/025-entity-integrity.md
+        - file: 30-schema-design/030-foreign-keys.ipynb
+        - file: 30-schema-design/035-diagrams.ipynb
+        - file: 30-schema-design/036-reverse-engineer.ipynb
+        - file: 30-schema-design/045-normalization.ipynb
+        - file: 30-schema-design/050-relationships.ipynb
+        - file: 30-schema-design/060-uuid.ipynb
+        - file: 30-schema-design/082-indexes.ipynb
+        - file: 30-schema-design/083-attach.ipynb
+        - file: 30-schema-design/084-filepath.ipynb
+        - file: 30-schema-design/086-adapted-types.ipynb
+        - file: 30-schema-design/091-alter.ipynb
+    - title: Example Designs
+      children:
+        - file: 35-example-designs/000-example-designs.ipynb
+        - file: 35-example-designs/010-sales-database.ipynb
+        - file: 35-example-designs/015-university-database.ipynb
+        - file: 35-example-designs/030-nations-database.ipynb
+        - file: 35-example-designs/040-hotel-database.ipynb
+        - file: 35-example-designs/070-julia.ipynb
+    - title: Manipulations
+      children:
+        - file: 40-manipulations/010-insert.ipynb
+        - file: 40-manipulations/020-delete.ipynb
+        - file: 40-manipulations/030-updates.ipynb
+        - file: 40-manipulations/040-transactions.ipynb
+        - file: 40-manipulations/80-caching.ipynb
+    - title: Queries
+      children:
+        - file: 50-queries/005-fetch.ipynb
+        - file: 50-queries/010-operators.ipynb
+        - file: 50-queries/020-restriction.ipynb
+        - file: 50-queries/030-projection.ipynb
+        - file: 50-queries/040-join.ipynb
+        - file: 50-queries/050-union.ipynb
+        - file: 50-queries/060-universal.ipynb
+        - file: 50-queries/070-aggregation.ipynb
+    - title: Computation
+      children:
+        - file: 60-computation/010-computation.ipynb
+    - title: Interfaces
+      children:
+        - file: 70-interfaces/011-dashboard.ipynb
+    - title: Exercises
+      children:
+        - file: 95-exercises/Assignment01.ipynb
+        - file: 95-exercises/Assignment02.ipynb
+        - file: 95-exercises/Assignment03.ipynb
+        - file: 95-exercises/Assignment04.ipynb
+        - file: 95-exercises/Assignment05.ipynb
+        - file: 95-exercises/Assignment06.ipynb
+        - file: 95-exercises/Assignment07.ipynb
+    
 site:
   template: book-theme
   options: 
     path_prefix: /datajoint-book
 
-# options:
-#  favicon: favicon.ico
-#   logo: site_logo.png
+options:
+  favicon: favicon.ico
+  logo: site_logo.png
+

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`# MyST build outputs`
`2`		`-/_build/`
	`2`	`+/_build/`