andy/Probability-and-Statistics-Notes
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Started a PreTeXt book.

Browse Source
This commit is contained in:
andyeisenberg
2025-12-28 16:44:30 +00:00
parent a6bd475da4
commit 5602f92eb7
12 changed files with 664 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+49 -18
View File
@@ -1,29 +1,60 @@
# PreTeXt Codespace
# My PreTeXt Book
Use this template repository to quickly start a new [PreTeXt](https://pretextbook.org) project entirely in the cloud, using GitHub Codespaces.
This README was generated by running `pretext new book`. You should feel free to edit this to describe your project.
## Instructions
Look for the green button at the very top right of this page. The button should say `Use this template` (if not make sure you are logged in to GitHub).
Click on the button and select "Create a new repository". On the next page, give your project a name, select public or private (this can be changed later), and click the "Create repository from template" button.
The main source file is `source/main.ptx`. This includes the other chapters of the book.
You now have a GitHub repository saved in your account. You can come back to that page any time you want to work on your project (note the URL or else find it in the list of your repositories when you log in to GitHub).
To compile the book as an accessible website, run `pretext build web` in a terminal from any directory of this project.
To start work on your project, go to the green button at the top of *your* repository's page, which will say `<> Code`.
To preview your output, run `pretext view web`.
1. Click on this button.
2. Click on the tab that says "Codespaces."
3. Click "Create codespace on main."
To deploy your output to GitHub pages, run `pretext deploy`.
This will open a new tab with a browser version of VS Code including everything set up to start working. (When you first create a codespace for a project, it may take 5-10 minutes; when you restart a codespace it will be much faster). The first thing you should do is create a new PreTeXT project.
To compile a pdf, run `pretext build print`.
### Creating a New Project
---
1. Open the command palette by hitting `Ctrl+Shift+P` (or `F1`) and start typing "pretext new". You will see a command titled "PreTeXt: New Project".
2. Hit `Enter` and select what sort of project you would like to create.
3. Select the current suggested folder for the location of your project.
Below you will find some advice for working with PreTeXt, including help with using the [PreTeXt Codespace](https://github.com/PreTeXtBook/pretext-codespace) online editor through GitHub if you don't want to install the required software on your own computer.
The window should reload and you will have your project there. This readme will be gone, but you will get a new one with some new hints.
Next time you want to work on your book, return to your newly created repository, go to the green `<> Code` button, and select the codespace you previously created. If you don't see that codespace (perhaps you deleted it to save space), you can always create a new codespace.
## Learning PreTeXt
See the [PreTeXt documentation](https://pretextbook.org/documentation.html) for links to a variety of resources.
We also recommend browsing through the [annotated sample article](https://pretextbook.org/examples/sample-article/annotated) and [annotated sample book](https://pretextbook.org/examples/sample-book/annotated/) if you want to find examples and see the PreTeXt source for those examples quickly.
## Using GitHub Codespaces
GitHub Codespaces are a way to set up your whole authoring system entirely in your browser. In case you are not already reading this inside a codespace, you can create one specifically designed for authoring in PreTeXt by using [this template](https://github.com/PreTeXtBook/pretext-codespace).
### Important: how to save your files
The most important thing to remember when authoring in a codespace is that you are making all your edits on a *virtual machine* off in some remote server farm. This means there is an extra step to save your files. You can save files in the editor (in your browser), but this just saves them to that virtual machine. To make sure you can access these files, even if the virtual machine goes away, you need to sync them to github.com. This is done by *committing* your changes and then *pushing* those commits (or "syncing" them). You might see a warning when you restart your codespace that you have "uncommitted changes" -- make sure you commit them when you are done working.
### Troubleshooting: Latex-images and pdfs
We have tried to keep the codespace small (so it starts up quickly and doesn't eat through your monthly storage allotment), so we do not include a full TeXLive distribution. We have tried to include most packages and fonts you are likely to need to generate images using `<latex-image>` elements, and to generate PDF print output. However, if you run into a situation where the LaTeX gives errors about packages missing (like it cannot find a `mypackage.sty` file), here is what you should do.
1. To quickly resolve the issue yourself, open a terminal (``Ctrl+Shift+` ``) and use the TeXLive Package Manager to install the missing package.
a. If you know that the package is called `mypackage` then enter the following two lines:
```bash
tlmgr install mypackage
tlmgr path add
```
b. If you don't know the name of the package, but know it should contain `mypackage.sty`, then you can search using
```bash
tlmgr search --global --all "mypackage.sty"
```
2. To ensure that you don't have to repeat this step every time you recreate the codespace, add the package name to the list of installs inside the file `.devcontainer/installLatex.sh` which gets run every time a codespace is created.
3. Better yet, post the name of the missing package to this [GitHub issue](https://github.com/PreTeXtBook/pretext-codespace/issues/21) and we will add it to the devcontainer. This has the advantage that you will still get updates that other authors submit (if you edit the `installLatex.sh` file, then it won't be updated when you run `pretext update`).
### Troubleshooting: sageplot images
By far the largest space-hog in a PreTeXt authoring environment is SageMath, which is only required if you generate images using sageplots. By default, SageMath is not installed in a PreTeXt codespace, but it should be easy to install if you need it.
Just open the command palette (`Ctrl+Shift+P` of `F1`) and search for "PreTeXt: Install SageMath". This will also update the `.devcontainer/devcontainer.json` file so that the next time you create a codespace for this project, it should install automatically.