I am working on a repository for creating differentiable loss functions:
I have a docs
folder in which I have MyST markdown code for documentation.
How do I launch a webpage using github pages?
The documentation here says to run the following command in the root:
myst init --gh-pages
But when I run the myst
command in my root it uses the README.md
instead of the markdown files in the docs/
folder.
What are the exact steps that I have to take to launch github pages?
I first run myst
command in the docs/
folder which creates a _build
folder inside docs/
. But it also autogenerates a .gitignore
that ignores the _build folder.
I then run the command myst init --gh-pages
from the root of the git repository but github pages failed to deploy.
I tried this test on a copy of my repository (so as to keep everything in the main repo organized).