Welcome to ObsidianFormattingExpert

Unfinished but usable

Watch the tool in action-

ObsidianFormattingExpert is an AI-powered tool that enhances your Obsidian Markdown notes. It improves the formatting, formats definitions, and creates automatic wikilinks between notes.

Disclaimer

Please backup your notes before using this tool. While the AI model is designed to enhance your notes, it may introduce errors or unwanted changes. Use at your own risk.

Features

• Better Formatting: Cleans up your notes for improved readability.
• Definition as Callouts: Highlights definitions using callout blocks.
• Automatic Wikilinks: Creates links between notes based on titles and headers.

How It Works

Leveraging the Ollama API, this tool runs a custom-trained AI model specifically designed to enhance Obsidian Markdown notes. The model aims to significantly improve the structure and readability of your content.

Getting Started

Clone the Repository

git clone https://github.com/BByrge/ObsidianFormattingExpert

Install Dependencies

Download and install - https://github.com/ollama/ollama

pip install -r requirements.txt

Start the Ollama API

Run ollama

ollama serve

Stop ollama (When you are done)

systemctl stop ollama

Configure the Tool

Edit the Config.py file to specify your vault path and settings.

Run the Tool

python main.py

Enjoy Improved Notes

Your enhanced notes will be saved in the output folder.

Useful links

https://github.com/ollama/ollama https://github.com/ollama/ollama/blob/main/docs/api.md#list-local-models https://dev.to/jayantaadhikary/using-the-ollama-api-to-run-llms-and-generate-responses-locally-18b7

Contributing

Contributions are welcome! Feel free to submit issues or pull requests.