Create and clone repo
-
run
myst init
-
Add sample
foo.md
file -
Add a table of content
myst init --write-toc
and addindex.md
-
Setup GitHub pages workflow with
myst init --gh-pages
. -
On Github "Build and deployment" activate source: Action
-
Check "Use your GitHub Pages website" and visit the page -> renders correctly!
-
run myst start to tweak the content.
-
Clone the repo https://github.com/pimsmath/syzygy-intro/tree/master
-
Open both projects in VS Code side by side and drag and drop the notebooks and image assets folder.
-
Rename the markdown files and adjust the toc.
-
Replace references to Syzygy with 2i2c
-
Fine tune the formatting