https://github.com/hyp3r00t/mindmaze

My second brain that leverages the power of Obsidian and Materials for MkDocs
https://github.com/hyp3r00t/mindmaze

learning learning-notes learning-resources mkdocs mkdocs-material notes notes-management-system obsidian

Last synced: about 1 month ago
JSON representation

My second brain that leverages the power of Obsidian and Materials for MkDocs

• Host: GitHub
• URL: https://github.com/hyp3r00t/mindmaze
• Owner: HYP3R00T
• Created: 2024-03-07T06:09:14.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-05-13T18:10:19.000Z (9 months ago)
• Last Synced: 2024-12-18T19:53:16.926Z (about 1 month ago)
• Topics: learning, learning-notes, learning-resources, mkdocs, mkdocs-material, notes, notes-management-system, obsidian
• Language: CSS
• Homepage: https://mindmaze.hyperoot.dev/
• Size: 15.5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Mindmaze

It is my `second brain` that leverages the power of Obsidian and Material for MkDocs. 

## Why?

After spending hours surfing the internet, I stumbled upon tons of interesting stuff that I wanted to keep track of. But I couldn't remember it all, no matter how hard I tried to organize my bookmarks. So, I decided to use Obsidian to link my notes together and make sense of it all. And to share my findings with others easily, I turned it into a website using mkdocs. So here it is, my online treasure trove for everyone to explore! 

## Usage

### Open in Obsidian

* To open this project in Obsidian, first clone it to your local machine.

    ```sh

    git clone https://github.com/HYP3R00T/mindmaze

    ```

* Open Obsidian and click on the `Open` button next to `Open folder as vault`.

* Navigate to the cloned copy of this repo and open the `mindmaze` folder (the inner one).

### Open in mkdocs

* Prerequisites:

   * `python` with `pip`

   * Visual Studio Code - Optional

* First clone it to your local machine.

    ```sh

    git clone https://github.com/HYP3R00T/mindmaze

    ```

* Open the local copy of the repo in `vscode`.

* Open a terminal within `vscode` create a python virtual environment.

    ```sh

    python -m venv .venv

    ```

* Activate the virtual environment

    ```sh

    # Windows

    .\.venv\Scripts\Activate.ps1

    # Linux

    source ./.venv/bin/activate

    ```

* Install python packages

    ```sh

    pip install -r requirements.txt

    ```

* To see the live preview, just run `mkdocs serve`.

## References

### [Obsidian.md](https://obsidian.md/)

**Plugins**

* [Excalidraw](https://github.com/zsviczian/obsidian-excalidraw-plugin)

* [Style Settings](https://github.com/mgmeyers/obsidian-style-settings)

* [admonitions](https://github.com/javalent/admonitions)

* [file-hider](https://github.com/Oliver-Akins/file-hider) - To hide custom stylesheets folder in Obsidian

* [sort-and-permute-lines](https://github.com/Vinzent03/obsidian-sort-and-permute-lines)

* [advanced-tables-obsidian](https://github.com/tgrosinger/advanced-tables-obsidian)

**Theme**

* [Catppuccin for Obsidian](https://github.com/catppuccin/obsidian)

### [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)

**Plugins**

* [mkdocs-callouts](https://pypi.org/project/mkdocs-callouts/)

* [mkdocs-roamlinks-plugin](https://pypi.org/project/mkdocs-roamlinks-plugin/)