Recently, I have been using Obsidian as my main software. After configuring it, the user experience is excellent. However, it is undeniable that the learning curve is high. Here, I will record the file organization format, plugins, and various settings I am currently using to facilitate quick start.
Recommended Obsidian Plugins and Configurations#
Project Address: https://github.com/anglee0323/ObsidianTemplate_Public
1. Introduction#
This repository stores the Obsidian templates I use, which achieve the following functions:
- Unified storage of attachments
- Images are stored locally or accessed through an image hosting service (images can be directly uploaded by pasting/dragging)
- Other attachments are stored in the "Attachment" folder
- Use Excalidraw for local drawing
- Customize Chinese fonts
- Customize common material libraries
- Use the Slideshow plugin for canvas presentations
- Use the Mindmap plugin to quickly draw mind maps
- Customize Chinese fonts
- Implement built-in Copilot in Obsidian (requires OpenAI API)
- Implement built-in browser in Obsidian
- Implement code highlighting
- Implement direct execution of markdown code snippets
- Adjust the UI to the "Github" style
- Hide menu scrolling
- Use Github for synchronization
2. Usage#
- Clone the repository to your local machine
cd
cd Desktop
git clone https://github.com/anglee0323/ObsidianTemplate.git
- Delete the
.git
file,Readme.md
file, andPlaceholder.txt
file
cd ObsidianTemplate
rm -rf .git
rm -rf Readme.md
cd ..
find ./ObsidianTemplate -name "Placeholder.txt" -delete
- Create a
.git
file and configure the repository or use iCloud for synchronization
cd ~/Desktop/ObsidianTemplate
git init
git add .
git commit -m "initial commit"
If you use iCloud for synchronization, use the following command and ignore steps
4.
and5.
(if your iCloud file location is different, please change it accordingly)
mv ~/Desktop/ObsidianTemplate ~/Library/Mobile\ Documents/iCloud~md~obsidian/Documents
Turn off the "Obsidian Git" plugin
- Add a remote repository
git remote add origin <your repo link.git>
git push --set-upstream origin main
- Set the automatic push time for the "Obsidian Git" plugin
It is recommended to set it to back up every 10 minutes
3. Organizational Structure#
Obsidian Template
├── README.md //README document
├── Attachment //Attachments
│ └── Placeholder.txt //Placeholder file to ensure the folder exists
│ └── Copilot //AI conversation copies
│ └── Excalidraw //Excalidraw whiteboard
│ └── Templates //Obsidian template files
└── Plugins //Plugins
│ └── Excalidraw
│ └── Fonts //Fonts
│ │ └── DongJingJieJiaoDeXiaoLangMan-2 //Chinese Excalidraw style font
│ └── Library //Drawing materials
│ └── Scripts //Scripts
│ └── Downloaded //Downloaded from third-party
└── Source //Resource files for storing PDFs, ePubs, Hand-Write-Notes, etc.
│ └── Placeholder.txt //Placeholder file to ensure the folder exists
└── .git //Git configuration files (need to be deleted manually)
└── .obsidian //Obsidian configuration files
└── plugins //Plugin files
└── themes //Theme files
└── xxx.json //Shortcut keys, workspaces, plugin configuration files
4. Others#
- For Excalidraw drawing, you can use the Raycast plugin to get vector images from the icons8 website
For more information, refer to: https://www.raycast.com/yug2005/icons8