📦 Markdown Builder Plugin for LM Studio

Narzędzie umożliwiające modelom AI tworzenie plików Markdown zgodnych ze standardami dokumentacyjnymi (file construction standards).

🎯 Funkcjonalność

Plugin udostępnia trzy narzędzia (tools) dla modeli LLM:

1. create_markdown_file

Tworzy plik Markdown z opcjonalnym YAML frontmatter i automatyczną walidacją struktury.

Parametry:

Parametr	Typ	Wymagane	Opis
file_name	string	✅	Nazwa pliku z rozszerzeniem .md
content	string	✅	Treść dokumentu Markdown
template_type	enum	❌	Typ szablonu (agent_rules, rosetta_stone, script_vision, script_spec, custom)
frontmatter	object	❌	Dane YAML (id, module, version, strict_mode, dependencies, ai_behavior)
force	boolean	❌	Nadpisz istniejący plik

2. validate_markdown_structure

Waliduje strukturę Markdown pod kątem zgodności ze standardami.

Parametry:

Parametr	Typ	Wymagane	Opis
content	string	✅	Treść do walidacji

3. fill_template

Wypełnia szablon Markdown danymi i zwraca gotowy dokument. Najbardziej przydatny do tworzenia dokumentacji z wzorców.

Parametry:

Parametr	Typ	Wymagane	Opis
template_type	enum	✅	Typ szablonu (script_vision, script_spec, rosetta_stone, agent_rules)
data	object	✅	Dane do wypełnienia szablonu
frontmatter	object	❌	Dane do YAML frontmatter

Przykładowe dane dla script_vision:

📐 Standardy Dokumentacyjne

Plugin wymaga od modelu przestrzegania następujących standardów:

YAML Frontmatter

Metadane Inline

ID Sekcji

• Symbol §: §1.1, §2.3
• Tagi: @@ID:nazwa

Formatowanie

• Emoji w tytułach: 🏗️, 📋, 🚀, 🎯
• Separator sekcji: ---
• Placeholdery: {{nazwa}} lub [Nazwa]
• Tabele dla danych porównawczych
• Bloki Mermaid dla diagramów:

🔧 Instalacja

📝 Przykładowe Użycie

Prośba do modelu:

Stwórz plik docs/agent_rules.md z zasadami agenta dla modułu "auth_system", wersja 1.0.0, z frontmatter i sekcjami §1-§4.

Model wywołuje tool:

📂 Struktura Projektu

🔒 Wymagania

• LM Studio >= 0.9.0
• Node.js >= 18.0.0
• TypeScript >= 5.3.3

📜 Licencja

MIT