GitHub setup

$\newenvironment {prompt}{}{} \newcommand {\accordion }[0]{} \newcommand {\ungraded }[0]{} \newcommand {\xmDefaultPreamble }[0]{xmPreamble.tex} \newcommand {\qrset }[1]{\setkeys {qr}{#1}} \newcommand {\xmDefaultPrintstyle }[0]{xmPrintstyle.sty} \newcommand {\luastring }[1]{"\luatexluaescapestring {#1}"} \newcommand {\luastringO }[1]{\luastring {\unexpanded \expandafter {#1}}} \newcommand {\luastringN }[1]{\luastring {\unexpanded {#1}}} \newcommand {\RestoreMathJaxEnvironment }[1]{\expandafter \let \csname #1\expandafter \endcsname \csname mathjax-#1\endcsname \expandafter \let \csname end#1\expandafter \endcsname \csname mathjax-end#1\endcsname } \newcommand {\DeclareMicrotypeVariants }[1]{} \newcommand {\DeclareMicrotypeAlias }[2]{} \newcommand {\LoadMicrotypeFile }[1]{} \newcommand {\DeclareMicrotypeFilePrefix }[1]{} \newcommand {\DeclareMicrotypeBabelHook }[2]{} \newcommand {\microtypesetup }[1]{} \newcommand {\microtypecontext }[1]{} \newcommand {\textmicrotypecontext }[2]{#2} \newcommand {\leftprotrusion }[1]{#1} \newcommand {\rightprotrusion }[1]{#1} \newcommand {\noprotrusionifhmode }[0]{} \newcommand {\lsstyle }[0]{} \newcommand {\lslig }[1]{#1} \newcommand {\maketitle }[0]{} \newcommand {\problem }[0]{ } \newcommand {\exercise }[0]{ } \newcommand {\question }[0]{ } \newcommand {\exploration }[0]{ } \newcommand {\ConfigureTheoremEnv }[1]{\renewenvironment {#1}[1][]{\refstepcounter {problem}\ifthenelse {\equal {###1}{}}{}{\HCode {<span class="theorem-like-title">}###1\HCode {</span>}}}{} \ConfigureEnv {#1}{\stepcounter {identification}\ifvmode \IgnorePar \fi \EndP \HCode {<div class="theorem-like problem-environment #1" id="problem\arabic {identification}" titletext=" \GetTranslation {#1}">}}{\ifvmode \IgnorePar \fi \EndP \HCode {</div>}\IgnoreIndent }{}{}} \newcommand {\dialogue }[0]{\begin {description}} \newcommand {\foldable }[0]{\stepcounter {identification}\ifvmode \IgnorePar \fi \EndP \HCode {<div id="foldable\arabic {identification}" class="foldable">}} \newcommand {\unfoldable }[1]{\HCode {<span class="unfoldable">}#1\HCode {</span>}} \newcommand {\selectAll }[0]{\refstepcounter {problem}} \newcommand {\freeResponse }[0]{\refstepcounter {problem}} \newcommand {\javascript }[0]{\NoFonts } \newcommand {\sageCell }[0]{\NoFonts } \newcommand {\sageOutput }[0]{\NoFonts } \newcommand {\sagesilent }[0]{\NoFonts } \newcommand {\ungraded }[0]{\ifvmode \IgnorePar \fi \EndP \HCode {<div class="ungraded">}\IgnoreIndent } \newcommand {\accordion }[0]{\ifvmode \IgnorePar \fi \EndP \HCode {<div class="accordion">} } \newcommand {\expandable }[2]{\stepcounter {identification}\ifvmode \IgnorePar \fi \EndP \HCode {<div class="accordion">\Hnewline }\HCode {<h3 class="#1">}#2\HCode {</h3>\Hnewline }\HCode {<div id="accordion-item\arabic {identification}" class="accordion-item #1-content">\Hnewline } } \newcommand {\paragraph }[1]{\HCode {<span class="paragraphHead">}#1\HCode {</span>}\par \IgnorePar } \newcommand {\subparagraph }[1]{\HCode {<span class="subparagraphHead">}#1\HCode {</span>}\par \IgnorePar } \newcommand {\outcome }[1]{\HCode {<span class="learning-outcome">#1</span>} } \newcommand {\javascriptCode }[0]{\NoFonts } \newcommand {\GetTranslation }[1]{#1} \newcommand {\ref }[1]{\HCode {<a class="reference" href="\##1">#1</a>}}$

How to create a new Ximera project.

All Ximera files must be hosted in a git repository. As an author, you have some choices as to how you proceed.

Starting fresh is easy. Select one of following repositories as a template:

https://github/ximeraProject/ximeraFirstSteps for playing around with some examples.
https://github/ximeraProject/ximeraNewProject for a minimal structure to get started.

When you are logged in to GitHub, you will in both cases have the option to make a new repository using the green “Use this template” button. Once the template is made, you are ready to go!

To deploy an existing repository copy the following folders and documents from either ximeraFirstSteps or ximeraNewProject into your repository.

.devcontainer/: (optional: provides a codespace setup)
xmScripts/: (build scripts and config)
global.css: (configuration for online content)
.vscode/: (provides Ximera buttons in VS Code)
.gitignore: (helps keep your repository clean)

Commit your changes to GitHub and check online that the files were added. Start a Codespace in your repository to build, edit and preview your course.

Deploying an existing repository without Codespaces, but working on your machine is more involved, and requires

Docker:: a development utility to easily run self-contained applications on your computer. Install and start Docker, it runs in the background and will start the Ximera container that contains TeX.
VS Code Desktop:: a popular text-editor with strong LaTeX, git, and Docker integration. It enables a UNIX-like command line interface on Windows machines via Microsoft’s WSL (Windows Subsystem for Linux).

Contact the Ximera developers for assistance. A typical workflow is:

(a): Open Docker and minimize the window.
(b): Open VS Code, do File $\to $ Open Folder, and select the folder of your git repo.
(c): To open files, do Ctrl-p and start typing file names. Any file committed to your git repository will be found, and files in .gitignore, will not be shown.
(d): To run a special command (like search and replace) do Ctrl-Shift-p, and search for the command.
(e): To toggle a UNIX-like terminal, use Ctrl-~. Note, technically it is Ctrl-‘, but perhaps this is more confusing than our misdirection.

If you’ve added .devcontainer/ to your repository and open your repository locally, VS Code will ask you if you want to open a Development Container. Probably you don’t, since you are working locall and VS Code with Docker will handle local containers. But if you answer “Yes” you can develop completely inside a container that will run on your local computer.