Skip to content

This is the repository for the Clowder project, an online collaborative resource for category theory and mathematics in general

License

Notifications You must be signed in to change notification settings

The-Clowder-Project/the-clowder-project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Clowder Project

This is the repository for the Clowder Project, an online resource for category theory and mathematics.

Requirements

This project requires:

  • Conda, for Gerby (which needs python3.6).
  • inkscape, for make pictures.

Initial setup

After installing the requirements, follow the instructions below.

  1. First, clone the repository via
git clone https://github.com/The-Clowder-Project/the-clowder-project
  1. Once inside the project's directory, run
make conda-create
  1. Next, activate the new conda environment via
conda activate clowder_py36_env
  1. Finally, run
make init

This will install all required dependencies. You can now proceed to build the website or the PDFs.

Building 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.:

  1. make all-books will build all book PDFs.
  2. make all-tags-books will build all book PDFs with tags.
  3. make all-chapters will build all chapter PDFs.
  4. make all-tags-chapters will build all chapter PDFs with tags.

In addition, there are make commands for particular “styles”. These are formatted as follows:

  1. make [style] will build the book PDF for the given style.
  2. make tags-[style] will build the book PDF with tags for the given style.
  3. make chapters-[style] will build all chapter PDFs for the given style.
  4. make tags-chapters-[style] will build all chapter PDFs with tags for the given style.

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.

Building the web version

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).

About

This is the repository for the Clowder project, an online collaborative resource for category theory and mathematics in general

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Contributors 2

  •  
  •