This is the repository for the Clowder Project, an online resource for category theory and mathematics.
This project requires:
- Conda, for Gerby (which needs
python3.6). inkscape, formake pictures.
After installing the requirements, follow the instructions below.
- First, clone the repository via
git clone https://github.com/The-Clowder-Project/the-clowder-project
- Once inside the project's directory, run
make conda-create
- Next, activate the new conda environment via
conda activate clowder_py36_env
- Finally, run
make init
This will install all required dependencies. You can now proceed to build the website or the PDFs.
The PDFs can be built by running make all, and in parallel by running make all-parallel.
There are also individual make commands for the chapters, books, etc.:
make all-bookswill build all book PDFs.make all-tags-bookswill build all book PDFs with tags.make all-chapterswill build all chapter PDFs.make all-tags-chapterswill build all chapter PDFs with tags.
In addition, there are make commands for particular “styles”. These are formatted as follows:
make [style]will build the book PDF for the givenstyle.make tags-[style]will build the book PDF with tags for the givenstyle.make chapters-[style]will build all chapter PDFs for the givenstyle.make tags-chapters-[style]will build all chapter PDFs with tags for the givenstyle.
The available styles are the following:
| Style | Typeface | Theorem Environments |
|---|---|---|
cm-tcb |
Computer Modern | tcbthm (Boxed) |
alegreya-tcb |
Alegreya | tcbthm (Boxed) |
alegreya-sans-tcb |
Alegreya Sans | tcbthm (Boxed) |
crimson-pro-tcb |
Crimson Pro | tcbthm (Boxed) |
eb-garamond-tcb |
EB Garamond | tcbthm (Boxed) |
cm |
Computer Modern | amsthm (Standard) |
alegreya |
Alegreya | amsthm (Standard) |
alegreya-sans |
Alegreya Sans | amsthm (Standard) |
crimson-pro |
Crimson Pro | amsthm (Standard) |
eb-garamond |
EB Garamond | amsthm (Standard) |
The default style is alegreya-sans-tcb.
To build and serve the website on localhost (127.0.0.1:5000), run make web-and-serve.
Alternatively:
- To serve on IPv6, run
make web-and-serve-on-ipv6. - To render extra PDF statistics, run
make web-and-serve-with-pdf-statistics(served on localhost).
