Probably functional. Testing
This commit is contained in:
@@ -1,3 +1,12 @@
|
||||
---
|
||||
title: Madomeda - Markdown Document Metadata Manager
|
||||
created: '2025-10-23T18:33:48+02:00'
|
||||
changed: '2025-10-23T18:33:48+02:00'
|
||||
authors:
|
||||
- Test User
|
||||
version: 8c4f612
|
||||
tags: []
|
||||
---
|
||||
# Madomeda - Markdown Document Metadata Manager
|
||||
|
||||
A Python tool for managing and normalizing frontmatter in markdown files within git repositories.
|
||||
@@ -64,15 +73,25 @@ SQLite database stores:
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
The first time you run Madomeda, it will automatically create a configuration directory at `~/.config/madomeda` (all platforms) with default settings.
|
||||
|
||||
### Optional: LLM Configuration
|
||||
|
||||
Edit `.env`:
|
||||
```
|
||||
OPENAI_API_URL=https://api.openai.com/v1
|
||||
OPENAI_MODEL=gpt-4
|
||||
OPENAI_API_KEY=your-api-key-here
|
||||
Edit `~/.config/madomeda/.env`:
|
||||
|
||||
```bash
|
||||
# Option 1: Use environment variable (recommended)
|
||||
OPENAI_API_KEY=$OPENAI_API_KEY
|
||||
|
||||
# Option 2: No LLM (empty string)
|
||||
OPENAI_API_KEY=""
|
||||
|
||||
# Option 3: Plain text (not recommended - security warning)
|
||||
OPENAI_API_KEY=sk-your-key-here
|
||||
```
|
||||
|
||||
For detailed configuration options, see [CONFIGURATION.md](CONFIGURATION.md).
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
@@ -131,9 +150,12 @@ tags:
|
||||
|
||||
- **[GETTING_STARTED.md](GETTING_STARTED.md)** - Step-by-step guide
|
||||
- **[USAGE.md](USAGE.md)** - Detailed usage examples
|
||||
- **[CONFIGURATION.md](CONFIGURATION.md)** - Configuration management
|
||||
- **[STRUCTURE.md](STRUCTURE.md)** - Project architecture
|
||||
- **[IMPLEMENTATION.md](IMPLEMENTATION.md)** - Technical details
|
||||
- **[PROJECT_SUMMARY.md](PROJECT_SUMMARY.md)** - Complete overview
|
||||
- **[ADD_ONLY_EXAMPLES.md](ADD_ONLY_EXAMPLES.md)** - Add-only mode guide
|
||||
- **[VERSION_FIELD.md](VERSION_FIELD.md)** - Version field behavior
|
||||
|
||||
## Project Structure
|
||||
|
||||
@@ -142,9 +164,9 @@ madomeda/
|
||||
├── madomeda.py # Main entry point
|
||||
├── inspect_db.py # Database inspection tool
|
||||
├── requirements.txt # Dependencies
|
||||
├── .env # LLM configuration
|
||||
│
|
||||
├── core/ # Core modules
|
||||
│ ├── config.py # Configuration management
|
||||
│ ├── database.py # SQLite management
|
||||
│ ├── repository.py # Git operations
|
||||
│ ├── frontmatter.py # YAML parsing
|
||||
@@ -154,12 +176,13 @@ madomeda/
|
||||
│ ├── changelog.py # Change logging
|
||||
│ └── processor.py # Main orchestration
|
||||
│
|
||||
└── madomeda.db # Database (in repo, gitignored)
|
||||
|
||||
~/.config/madomeda/ # User configuration (auto-created)
|
||||
├── .env # API configuration
|
||||
├── templates/ # Frontmatter templates
|
||||
├── rules/ # Validation rules
|
||||
├── prompts/ # LLM prompts
|
||||
│
|
||||
├── madomeda.db # Database (gitignored)
|
||||
└── madomeda_changelog.txt # Change log
|
||||
└── prompts/ # LLM prompts
|
||||
```
|
||||
|
||||
## Templates
|
||||
|
||||
Reference in New Issue
Block a user