An (universitary) knowledge pool of a CS student, using the Obsidian.md Markdown tool with it's extended Markdown syntax and cross-linking capabilities.
This repo is thought to hold the main configuration parts & knowledge I gathered from this project, where as the summaries are split up to some git sub-module repositories for ease of maintaince.
Every submodule repository should hold it's own REAMDE.md with a some amount of explanation of it's content & the thoughts behind it. Submodules I created Anki flashcards decks with (which are public) are linked in the specified submodule repository.
Be aware that the summaries were initially created for myself and therefore are sensitive to my personal way of thinking and understanding.
If you finde some of it not optimal, please consider contributing via the corresponding repo or the contact section below.
Typically,
git clone --depth=1 --shallow-submodules --recurse-submodules https://github.com/becknik/Universus.git
does the job if you're not interested in this repos commit history.
If you however are only interested in some of the submodules, you can also specify them with
git clone --depth=1 --shallow-submodules --recurse-submodules=Uni <--recurse-submodules=...> https://github.com/becknik/Universus.git
- Install obsidian from a package manager (yes, they also exists on non-Unix) or download it from the official site
- To get used to the interface I'd recommend you to watch some tutorials on this point or just click and read through the menus, especially "Settings > Shortcuts" or "Ctrl + p"
Consider writing me an private mail, contact me anywhere else you can find me loitering or just open an issue/ pull request :^)
I appreciate every bit/ byte of work aiming to enhance this project. Feedback is also much in demand!
This projects approach of managing summaries provide the following advantages:
- Highly modifiable & extendable summaries due to the easy Markdown markup language syntax & it's resulting customizability in appearance
- A dynamic way of linking those summaries due to the possibility to create wikilinks
- The use of tags to organize summarizing files in between folders
- Fast lookup of summaries by just searching for summary file names or YAML specified aliases ("Ctrl + o")
- A neat (eyecandy) way to view the network of references between summaries with the graph view as shown above
- The best way I found (so far) to share Anki flashcard decks and keep them half-way up-to-date with a reasonable way to provide additions and corrections by it's users with git repos
- Summary files can easily be shared by exportation them to PDFs & much more features Obsidian & it's plugin system provide
Drawbacks:
- There is a learning curve figuring out the organization of the summaries - I tried to sum up my personal choices in this repositories wiki
- Managing the project/ the structure & writing idioms
- How to deliver always up-to-date Anki flashcard decks to the people using them
- Currently, AnkiWeb is used for publishing the decks manually in the web interface on (nearly) every change
- Sometimes I forget/ am tried to update the decks on AnkiWeb - an automation of building the decks on push would be nice
- AnkiWeb deleting some decks due to no downloads :(
- AnkiWeb published decks are available just 24h after publishing - which is REALLY annoying...
- A user can only upload up to 20 decks updates per month. This terminates collaboration
- How to coordinate summary writing with multiple participants
- Even tho formatters & regex can be used to ensure a consistent style, I think this might be really hard to merge
- Sadly, for some reasons the degree of contribution to this project is really low - seems like there is no reason for anybody reading through my docs to understand how this is working
This project's name was inspired by my friends and fellow students Anton Sproll UNIverum project. Also, I just took notice of Obsidian's existence because of this great dude :^)