Skip to content

A centralized Obsidian vault used by SpaceDot members for everything AcubeSAT-related, with MkDocs integration for automatic webpage deployment through GitLab CI and GitLab Pages

License

Notifications You must be signed in to change notification settings

AcubeSAT/obsidian

Repository files navigation

Description

https://acubesat.gitlab.io/documentation/obsidian/

This repository hosts a complete Obsidian vault, together with plugins, configuration, etc. As some SpaceDot members are starting to experiment with using Obsidian for notetaking in the scope of the AcubeSAT project, this is an attempt to gather everything in a single, centralized knowledge base. Additionally, this repository contains all the necessary files for MkDocs integration, using GitLab CI. This allows for automatically building and deploying a website generated by the markdown notes, through GitLab Pages:

index-example

Table of Contents

Click to expand

[[TOC]]

Features

The repository hosts two different things: the Obsidian vault itself, and the configuration related to generating and deploying the webpage. Check Guides/!

Obsidian

The theme currently used is [colineckert/obsidian-things: An Obsidian theme inspired by the beautifully-designed app, Things.(https://github.com/colineckert/obsidian-things), in Dark mode.

Plugins

Community plugins:

valentine195/obsidian-admonition: Adds admonition block-styled content to Obsidian

Click to view screenshot

plugin-admonition

tgrosinger/advanced-tables-obsidian: Improved table navigation, formatting, and manipulation in Obsidian

Click to view screenshot

plugin-advanced-tables

GitHub - zolrath/obsidian-auto-link-title: Automatically fetch the titles of pasted links

Click to view screenshot

plugin-auto-link-title

hans/obsidian-citation-plugin: Obsidian plugin which integrates your academic reference manager with the Obsidian editor. Search your references from within Obsidian and automatically create and reference literature notes for papers and books.

Click to view screenshot

plugin-citation

oliveryh/obsidian-emoji-toolbar: Quickly search for and add emojis to your editor

Click to view screenshot

plugin-emoji-toolbar

zsviczian/obsidian-excalidraw-plugin: A plugin to edit and view Excalidraw drawings in Obsidian

Click to view screenshot

plugin-excalidraw

nothingislost/obsidian-hover-editor: Transform the Page Preview hover into a working editor instance

Click to view screenshots

plugin-hover-editor-1 plugin-hover-editor-2

mgmeyers/obsidian-kanban: Create markdown-backed Kanban boards in Obsidian.

Click to view screenshot

plugin-kanban

denolehov/obsidian-git: Backup your Obsidian vault with git

Click to view screenshot

plugin-git

ozntel/oz-image-in-editor-obsidian: This Obsidian plugin to view Images, Transclusions, iFrames and PDF Files within the Editor without a necessity to switch to Preview.

Click to view screenshot

plugin-image-in-editor

denolehov/obsidian-url-into-selection: Paste URLs into selected text "notion style"

Click to view screenshot

plugin-url-into-selection

deathau/sliding-panes-obsidian: Andy Matuschak Mode as a plugin

Click to view screenshot

plugin-sliding-panes

Webpage

search-example

MkDocs

Built-in Markdown extensions:

  • footnotes: Define, reference and render footnotes ([^1] Markdown-esque syntax)
  • attr_list: Add HTML attributes and CSS classes to almost every Markdown inline- and block-level element
  • pymdownx.highlight: Syntax highlighting and configuration
  • pymdownx.superfences: Nested fences (``` Markdown blocks), custom fences (e.g. for rendering flowcharts), etc.
  • pymdownx.details: Good-looking collapsible elements that hide their content leveraging the HTML <details><summary> tags
  • pymdownx.magiclink: Auto-linking, shorthand links, mentions, GitHub/Lab shorthands, commits, diff/compare, etc.
  • pymdownx.saneheaders: Only recognize as markdown headers text where the hashtag is separated with the text (i.e. # is a header, #is not a header)
  • pymdownx.tasklist: Good-looking, customizable GFM-style task lists ([ ] stuff)
  • pymdownx.emoji: Render emojis with the good ol' :an-emoji: colon sytax
  • admonition: Admonitions, aka call-outs, support. Syntax used differs than the one used from the respective Obsidian plugin, should look into this
  • toc: Table Of Contents support

Community plugins:

  • search: Search (bar) support using lunr.js
  • roamlinks: Relative linking between documents, convert Obsidian [[roamlinks]]
  • exclude:: Exclude files from being built by MkDocs. Used to not build Excalidraw or Kanban Obsidian files, etc.

About

A centralized Obsidian vault used by SpaceDot members for everything AcubeSAT-related, with MkDocs integration for automatic webpage deployment through GitLab CI and GitLab Pages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published