https://github.com/descent098/compsci
A Computer Science Knowledge Base based on quartz and obsidian
https://github.com/descent098/compsci
Last synced: 10 months ago
JSON representation
A Computer Science Knowledge Base based on quartz and obsidian
- Host: GitHub
- URL: https://github.com/descent098/compsci
- Owner: Descent098
- License: mit
- Created: 2024-01-06T19:50:15.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-10T21:21:07.000Z (about 1 year ago)
- Last Synced: 2025-04-02T10:18:11.236Z (10 months ago)
- Language: TypeScript
- Homepage: http://kieranwood.ca/compsci/
- Size: 21.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# Compsci KB
This repository is the source code for [https://kieranwood.ca/compsci](https://kieranwood.ca/compsci), a knowledge base for computer science information.
## Technical details
All the content is implemented with markdown and can be found in `/compsci-kb`. The editing is meant to be done using [obsidian](https://obsidian.md/), and you should import `/compsci-kb` as a new vault for it to work as intended.
By default `/_meta` is ignored, and is used in conjuntion with the templater plugin in obsidian to create new files.
To run the dev server locally use:
1. `npm i` to install dependencies, you will only need to do this once
2. `npx quartz build --serve` to show the local version on port 8080
To build the site:
1. `npm i` to install dependencies, you will only need to do this once
2. `npx quartz build` which will dump the files to `/site`
## Quartz Details
This whole site is based on [Quartz V4](https://github.com/jackyzha0/quartz)
🔗 Read the documentation and get started if you're interested: https://quartz.jzhao.xyz/
## Update Guide
There are a few config changes made that are hardcoded, and need to be persisted. You will need to manually check differences in the following files:
- `quartz.config.ts`
- `quartz.layout.ts`
- `/quartz/static/icon.png`
- `/quartz/static/og-image.png`
Additionally you will need to update `/quartz/cli/args.js` to change the default `-d` flag from `content` to `compsci-kb` (or else no content will be found). Lastly update the footer to include the content license (under the quartz indicator):
```html
The Compsci KB by Kieran Wood is licensed under CC BY-SA 4.0
```