https://github.com/surgoshare/docs-mkdocs-obsidian

🌐 GH Pages Deployed - CSS and Config - MkDocs config for Obsidian
https://github.com/surgoshare/docs-mkdocs-obsidian

mkdocs mkdocs-material obsidian static-site team-collaboration wiki

Last synced: 15 days ago
JSON representation

🌐 GH Pages Deployed - CSS and Config - MkDocs config for Obsidian

• Host: GitHub
• URL: https://github.com/surgoshare/docs-mkdocs-obsidian
• Owner: surgoshare
• Created: 2024-08-09T04:24:34.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-30T20:40:50.000Z (3 months ago)
• Last Synced: 2024-10-31T05:05:22.483Z (15 days ago)
• Topics: mkdocs, mkdocs-material, obsidian, static-site, team-collaboration, wiki
• Language: HTML
• Homepage: https://surgoshare.github.io/Docs-MkDocs-Obsidian/
• Size: 896 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
---

icon: material/information

title: About

url_github: https://surgosync.github.io/MkDocs-Obsidian/

---

This site is powered by [MkDocs Material Theme](https://squidfunk.github.io/mkdocs-material) & configured to visually and functionally work well with [Obsidian.md](https://obsidian.md/), the popular note taking app. 

If working in Obsidian or any markdown notes app, it's best to have the flexibility to place markdown files in the root directory, or anywhere you wish, and this configuration allows for this, bypassing the normal need to place files in the `/docs/` directory, among a handful of other features summarized below. 

##  🎛️ 

#### Hidden Config Folder 

Moves all config files to a hidden .mkdocs directory so not visible in Obsidian

## 🎨 

#### Custom CSS

Adds a custom.css file that mirrors default Obsidian theme. 

#### Logo and Favicons

Adds Obsidian logo and favicon for fun!

## 🧩

#### SameDir  

Allows for markdown docs to live in the root directory instead of "/docs/" which makes it much nice when integrating many git repos into one vault -- just the ability to keep any folder structure desired. 

#### Roamlinks 

This plugin allows for wikilinks support ... presumably it scans the entire directory for the filename and then gets the full path and inserts it as in normal markdown and required for a normal website.