MATH201/README.md

27 lines
2.7 KiB
Markdown
Raw Normal View History

2023-09-30 21:11:16 -06:00
# What is this?
2023-10-01 00:12:03 -06:00
Welcome! This repository is the source code behind the page [sasserisop.com/MATH201](https://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](./content) folder. The notes are then built into a website using [HUGO](https://gohugo.io), a static site generator. I used a theme called [Zettles](https://github.com/crisrojas/Zettels), I have slightly modified it so that it can render math using [KaTeX](https://katex.org).
2023-09-30 21:11:16 -06:00
# Can I contribute?
2023-09-30 23:02:32 -06:00
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](mailto:mail@sasserisop.com) Please note that I will not accept adding instructor materials without their prior consent. I also do not condone academic dishonesty.
2023-09-30 22:55:13 -06:00
This whole thing is very experimental. I appreciate any help!
2023-09-30 21:11:16 -06:00
# Can I steal your repository and host my own notes server?
Yes. Consider sharing it with your classmates ;)
2023-09-30 22:55:13 -06:00
Here's a quick rundown of how to build from source:
2023-10-01 00:12:03 -06:00
1) download or clone the repository ```git clone https://git.sasserisop.com/Sasserisop/MATH201```
2023-09-30 22:55:13 -06:00
2) make sure you have hugo installed
2023-10-01 00:12:03 -06:00
3) open a command prompt in the MATH201/ directory and run the command ```hugo server --disableFastRender```
2023-09-30 22:55:13 -06:00
4) visit your site by opening http://localhost:1313 on your browser.
2023-09-30 21:11:16 -06:00
2023-10-30 20:10:10 -06:00
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](https://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:
2023-10-30 20:13:22 -06:00
[https://www.vultr.com/?ref=9230694-8H](https://www.vultr.com/?ref=9230694-8H) If that doesn't work, try removing the -8H at the end.
2023-10-30 20:10:10 -06:00
2023-09-30 22:55:13 -06:00
# Can I add my own notes? And for other classes?
2023-10-30 20:10:10 -06:00
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.