Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jonsterling/math

A mini-book on category theory. Superseded by https://github.com/jonsterling/forest
https://github.com/jonsterling/math

Last synced: 20 days ago
JSON representation

A mini-book on category theory. Superseded by https://github.com/jonsterling/forest

Awesome Lists containing this project

README

        

***Notice:*** These lecture notes have now been incorporated into my [Forest](https://github.com/jonsterling/forest). This repository will not be updated except in order to fix broken redirects.

-----

This repository is based on [Krater](https://github.com/paolobrasolin/krater),
a tool for building math-rich websites; the purpose of the present code is to
support "Stacks Project"-style websites, where you create a bunch of files like
`_nodes/00A4.md` that may import each other, and then specify a root like
`_lectures/lecture.md` that imports some node.

### Running on your machine

You will need a running LaTeX installation, including `latexmk`, `dvisvgm` and whatever engine and packages you plan on using.
Chances are that if you're reading this you already have everything you need.

You will need to [install Ruby 2.7.5][ruby-install-url]; you will need to ensure that
you have ghostscript installed, with the `LIBGS` environment variable correctly
set. On macOS with Homebrew, after installing ghostscript you must add the
following line to your `.bashrc` or `.zshrc`:

```bash
export LIBGS=/opt/homebrew/lib/libgs.dylib
```

After that, you can simply

```bash
# install dependencies
bundle
# run Jekyll
bundle exec jekyll serve
```

and your website will be available at `http://127.0.0.1:4000//`.

[ruby-install-url]: https://www.ruby-lang.org/it/documentation/installation/

### Node UID policy and drafts

1. Node UIDs should be added in order; so if the greatest node UID is `00X2`,
then the next node that is committed should be `00X3`.

2. When a new node `00X3` is committed, it is permanent: it is not permitted to
rename it, however it is permitted to *delete* it.

If two branches contain drafted nodes, when one is merged, the node UIDs chosen
on the other branch have to be renamed so that when *they* are committed to
`main`, there are no conflicts and node UIDs are consecutive. This causes
considerable friction, so we will use the following method for drafts.

1. In a draft, name any *new* node with an underscore `_00X3`.

2. Prior to merging, you may acquire a temporary lock on the entire repository
and rename every node draft node to the next consecutive "permanent" UID.

3. Pull requests that involve draft nodes should be squashed prior to being
merged; this is because we want to avoid the auto-generated changelog from
referring to draft nodes that do not exist at merge-time.

The script `mint-node.rkt` will assist you in determining what the next
permanent UID is. For now you must handle the renaming manually, but in the
future we can include scripts to automate this process.