MATH201/README.md

2.8 KiB

What is this?

Welcome! This repository is the source code behind the page sasserisop.com/MATH201. The notes are originally written in markdown. In my case, I write my notes using obsidian during the lecutre and revise it when I'm home, although I am trying to move away from that piece of software. The notes are stored as .md files under the content folder. The notes are then built into a website using HUGO, a static site generator. I used a theme called Zettles, I have slightly modified it so that it can render math using KaTeX.

Can I contribute?

Absolutely! You can add your own notes or fixes or anything really. You can contribute by creating an issue or by making a pull request. You can also contact me directly if you have any suggestions or concerns: mail@sasserisop.com Please note that I will not accept adding instructor materials without their prior consent. I also do not condone academic dishonesty.

This whole thing is very experimental. I appreciate any help!

Can I steal your repository and host my own notes server?

Yes. Consider sharing it with your classmates ;)

Here's a quick rundown of how to build from source:

  1. download or clone the repository git clone https://git.sasserisop.com/Sasserisop/MATH201
  2. make sure you have hugo installed
  3. if you are using localhost, inside of themes/zettels/assets/js/search.js set 'const localhost' to true.
  4. open a command prompt in the MATH201/ directory and run the command hugo server --disableFastRender
  5. visit your site by opening http://localhost:1313 on your browser.

Now if you want to host it on a live website, you can run: hugo This will generate a bunch of files in the public folder. Basically you copy paste all that into your web server. If you wanna get started running your own website, there's a lot of options, personally I host my website on a VPS provider, in my case Vultr. This might be the most nerdy way to do it, but you get a lot of control. It costs me 3.50$USD/month plus about 10$/year for the domain name. I use nginx as my webserver. I learned how to set up everything from landchad.net. He's got good tutorials there. By the way, if you decide to use Vultr, I have a referral code you can use: https://www.vultr.com/?ref=9230694-8H If that doesn't work, try removing the -8H at the end.

Can I add my own notes? And for other classes?

Yes. You might need to contact me directly so we can get it to work. I think it would be so cool if we could build a library of many classes, all free and publicly available. Wouldn't that be sick? It's kinda the point I'm making this open source so people can build on the idea.