style: add Tailwind Typography plugin for proper markdown rendering

Installed @tailwindcss/typography plugin to fix 'wall of text' issue in documentation.
The prose classes now properly style markdown HTML elements with:
- Proper margins and spacing for headings, paragraphs, lists
- Line-height and typography improvements
- Styled code blocks, blockquotes, tables, and links

Changes:
- Add @tailwindcss/typography to devDependencies
- Configure plugin in tailwind.config.ts
- Regenerate CSS with typography styles included
This commit is contained in:
2026-02-02 20:54:18 -05:00
parent 59554d37f6
commit d102b6f976
6 changed files with 8 additions and 6 deletions
+1 -1
View File
@@ -98,7 +98,7 @@ The first user to register automatically becomes an admin.
- **[docs/user/settings-guide.md](docs/user/settings-guide.md)** - Settings and preferences - **[docs/user/settings-guide.md](docs/user/settings-guide.md)** - Settings and preferences
### For Developers ### For Developers
- **[docs/developer/api/INDEX.md](docs/developer/api/INDEX.md)** - Complete API documentation - **[docs/developer/api/api-reference.md](docs/developer/api/api-reference.md)** - Complete API documentation
- **[docs/contributing/DEVELOPMENT.md](docs/contributing/DEVELOPMENT.md)** - Development workflow - **[docs/contributing/DEVELOPMENT.md](docs/contributing/DEVELOPMENT.md)** - Development workflow
--- ---
+2 -2
View File
@@ -8,7 +8,7 @@ import (
"strings" "strings"
"github.com/yuin/goldmark" "github.com/yuin/goldmark"
"github.com/yuin/goldmark-highlighting" highlighting "github.com/yuin/goldmark-highlighting"
"github.com/yuin/goldmark/extension" "github.com/yuin/goldmark/extension"
"github.com/yuin/goldmark/parser" "github.com/yuin/goldmark/parser"
"github.com/yuin/goldmark/renderer/html" "github.com/yuin/goldmark/renderer/html"
@@ -57,7 +57,7 @@ func (h *DocsHandler) LoadDocument(docPath string) (*templates.Document, error)
// Default to INDEX.md if root // Default to INDEX.md if root
if docPath == "" || docPath == "docs" { if docPath == "" || docPath == "docs" {
docPath = "INDEX.md" docPath = "index.md"
} else { } else {
// Remove /docs prefix if present // Remove /docs prefix if present
docPath = strings.TrimPrefix(docPath, "docs/") docPath = strings.TrimPrefix(docPath, "docs/")
+2 -2
View File
@@ -30,7 +30,7 @@ func (h *DocsHandler) BuildNavigation() *templates.Navigation {
for _, doc := range docs { for _, doc := range docs {
// Skip INDEX.md files in subdirectories (they're section landing pages, not nav items) // Skip INDEX.md files in subdirectories (they're section landing pages, not nav items)
// Only show root INDEX.md, skip all others like user/INDEX.md, api/INDEX.md, etc. // Only show root INDEX.md, skip all others like user/INDEX.md, api/INDEX.md, etc.
if strings.HasSuffix(doc, "INDEX.md") && doc != "INDEX.md" { if strings.HasSuffix(doc, "index.md") && doc != "index.md" {
continue continue
} }
@@ -151,7 +151,7 @@ func (h *DocsHandler) getDocIcon(docPath string) string {
if strings.Contains(docPath, "contributing") || strings.Contains(docPath, "DEVELOPMENT") { if strings.Contains(docPath, "contributing") || strings.Contains(docPath, "DEVELOPMENT") {
return "🛠️" return "🛠️"
} }
if strings.Contains(docPath, "INDEX") { if strings.Contains(docPath, "index") {
return "📚" return "📚"
} }
if strings.Contains(docPath, "troubleshooting") { if strings.Contains(docPath, "troubleshooting") {
+1
View File
@@ -11,6 +11,7 @@
}, },
"devDependencies": { "devDependencies": {
"@tailwindcss/forms": "^0.5.7", "@tailwindcss/forms": "^0.5.7",
"@tailwindcss/typography": "^0.5.19",
"autoprefixer": "^10.4.0", "autoprefixer": "^10.4.0",
"tailwindcss": "^3.4.0", "tailwindcss": "^3.4.0",
"typescript": "^5.9.3" "typescript": "^5.9.3"
+1
View File
@@ -32,6 +32,7 @@ const config: Config = {
}, },
plugins: [ plugins: [
require('@tailwindcss/forms'), require('@tailwindcss/forms'),
require('@tailwindcss/typography'),
], ],
}; };
+1 -1
View File
File diff suppressed because one or more lines are too long