MyST Author edits files on disk and leaves git to the host. Each host already has a git client, so you pull a project from GitHub, edit it, and push it back without anything from MyST Author.
GitHub Codespaces¶
Open the MyST Author Codespace, then clone your project in the terminal:
gh repo clone you/your-bookIt lands inside the MyST Author checkout, which is fine for a session. Open a page in it. The VS Code extension finds the project, so completions, the preview and the MyST TOC follow along.
Codespaces signs you in to GitHub for the repository it was opened from, which is MyST Author’s. Pushing to your own repository needs one more sign-in, in the terminal:
unset GITHUB_TOKEN # otherwise gh keeps using the Codespace's token
gh auth login
gh auth setup-git
git push # from this terminal, which has the new sign-inVS Code’s Source Control view can commit as usual, but it may keep pushing with the Codespace’s token, so push from that terminal.
To edit the project in the web editor instead, point it at the clone as Get started describes.
JupyterHub¶
Your hub needs the JupyterLab extension and its setup, plus nbgitpuller, jupyterlab-git and gh.
binder/environment.yml lists them all.
Make a link with the nbgitpuller link generator. Fill in your hub’s URL, the repository, JupyterLab as the application, and the page as the file to open. Opening the link clones the project into your home folder, or pulls the latest changes if it’s already there, and opens the page. The extension follows the file you open, so Lab can stay at your home folder.
To commit and push, use the Git view in the left sidebar, or a terminal. Sign in once, and your home folder keeps the credentials:
gh auth login
gh auth setup-gitBinder¶
The MyST Author Binder has nbgitpuller, jupyterlab-git and gh.
A Binder is a throwaway copy, so pulling is easy and pushing takes a sign-in each session.
To pull your project into it, make a link with the nbgitpuller link generator.
Choose Binder, give it choldgraf/myst-author as the environment repository, and your project as the content repository.
This one opens the mystmd-lsp demo project:
To push, sign in from a terminal in the Binder, then use the Git view or git push:
gh auth login # pick GitHub.com and HTTPS, then paste the code it shows into github.com
gh auth setup-gitThe sign-in lasts until the Binder session ends. Anyone with the Binder’s URL can use it while it runs, so sign in only from a Binder you launched yourself.