bloggy 0.1.43__py3-none-any.whl → 0.2.3__py3-none-any.whl

bloggy-0.2.3.dist-info/METADATA

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: bloggy
+Version: 0.2.3
+Summary: A lightweight, elegant blogging platform built with FastHTML
+Home-page: https://github.com/yeshwanth/bloggy
+Author: Yeshwanth
+Author-email: 
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/yeshwanth/bloggy
+Project-URL: Repository, https://github.com/yeshwanth/bloggy
+Project-URL: Issues, https://github.com/yeshwanth/bloggy/issues
+Keywords: fasthtml,blog,markdown,htmx,mermaid,sidenotes
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: FastAPI
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-fasthtml>=0.6.9
+Requires-Dist: mistletoe>=1.4.0
+Requires-Dist: python-frontmatter>=1.1.0
+Requires-Dist: uvicorn>=0.30.0
+Requires-Dist: monsterui>=0.0.37
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: black>=24.0.0; extra == "dev"
+Requires-Dist: ruff>=0.5.0; extra == "dev"
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+---
+title: Bloggy
+---
+
+<p align="center">
+  <img src="static/icon.png" alt="Bloggy icon" class="bloggy-icon" style="width: 256px;">
+</p>
+
+<p class="bloggy-caption" style="text-align: center;">
+  Markdown lovers write<br>
+  Python roots, JavaScript sparks<br>
+  Styles without limits
+</p>
+
+---
+
+Bloggy is a Python‑first blogging tool: drop in Markdown, get a site instantly.
+Simple by default, infinitely customizable for CSS lovers.
+
+## Quick Start
+1. Install Bloggy:
+   ```bash
+   pip install bloggy
+   ```
+
+2. Create a directory with your markdown files:
+   ```bash
+   mkdir my-blog
+   cd my-blog
+   echo "# Hello World" > hello.md
+   mkdir -p posts
+   echo "# My First Post\nThis is a sample blog post." > posts/first-post
+   ```
+
+3. Run Bloggy:
+   ```bash
+   bloggy .
+   ```
+
+4. Open your browser at `http://127.0.0.1:5001`
+
+
+## Key Features
+
+### ✨ Advanced Markdown Features
+- **Footnotes as Sidenotes**: `[^1]` references become elegant margin notes on desktop, expandable on mobile with smooth animations
+- **YouTube Embeds**: Use `[yt:VIDEO_ID]` or `[yt:VIDEO_ID|Caption]` for responsive iframe cards with aspect-ratio containers
+- **Task Lists**: `- [ ]` / `- [x]` render as custom styled checkboxes (green for checked, gray for unchecked) with SVG checkmarks
+- **Mermaid Diagrams**: Full support for flowcharts, sequence diagrams, state diagrams, Gantt charts, etc.
+- **Interactive Diagrams**: 
+  - Zoom with mouse wheel (zooms towards cursor position)
+  - Pan by dragging with mouse
+  - Built-in controls: fullscreen, reset, zoom in/out buttons
+  - Auto-scaling based on diagram aspect ratio (wide diagrams like Gantt charts get special handling)
+  - Fullscreen modal viewer with dark mode support
+- **Theme-aware Rendering**: Diagrams automatically re-render when switching light/dark mode via MutationObserver
+- **Mermaid Frontmatter**: Configure diagram size with YAML frontmatter (width, height, min-height)
+- **Tabbed Content**: Create multi-tab sections using `:::tabs` and `::tab{title="..."}` syntax with smooth transitions
+- **Relative Links**: Full support for relative markdown links (`./file.md`, `../other.md`) with automatic path resolution
+- **Plain-Text Headings**: Inline markdown in headings is stripped for clean display and consistent anchor slugs
+- **Math Notation**: KaTeX support for inline `$E=mc^2$` and block `$$` math equations, auto-renders after HTMX swaps
+- **Superscript & Subscript**: Use `^text^` for superscript and `~text~` for subscript (preprocessed before rendering)
+- **Strikethrough**: Use `~~text~~` for strikethrough formatting
+- **Pandoc-style Attributes**: Add classes to inline text with `` `text`{.class #id} `` syntax for semantic markup (renders as `<span>` tags, not `<code>`)
+- **Cascading Custom CSS**: Add `custom.css` or `style.css` files at multiple levels (root, folders) with automatic scoping
+
+See the full list in [Markdown Writing Features](bloggy%20manual/markdown-features.md).
+
+### 🎨 Modern UI
+- **Responsive Design**: Works beautifully on all screen sizes with mobile-first approach
+- **Three-Panel Layout**: Posts sidebar, main content, and table of contents for easy navigation
+- **Dark Mode**: Automatic theme switching with localStorage persistence and instant visual feedback
+- **HTMX Navigation**: Fast, SPA-like navigation without full page reloads using `hx-get`, `hx-target`, and `hx-push-url`
+- **Collapsible Folders**: Organize posts in nested directories with chevron indicators and smooth expand/collapse
+- **Sidebar Search**: HTMX-powered filename search with results shown below the search bar (tree stays intact)
+- **PDF Posts**: PDFs show up in the sidebar and open inline in the main content area
+- **Auto-Generated TOC**: Table of contents automatically extracted from headings with scroll-based active highlighting
+- **TOC Autoscroll + Accurate Highlights**: Active TOC item stays in view and highlight logic handles duplicate headings
+- **Mobile Menus**: Slide-in panels for posts and TOC on mobile devices with smooth transitions
+- **Sticky Navigation**: Navbar stays at top while scrolling, with mobile menu toggles
+- **Active Link Highlighting**: Current post and TOC section highlighted with blue accents
+- **Auto-Reveal in Sidebar**: Active post automatically expanded and scrolled into view when opening sidebar
+- **Ultra-Thin Scrollbars**: Custom styled 3px scrollbars that adapt to light/dark theme
+- **Frosted Glass Sidebars**: Backdrop blur and transparency effects on sidebar components
+
+| Feature                     | Description                                      |
+|-----------------------------|--------------------------------------------------|
+| FastHTML Integration        | Built on FastHTML for high performance and ease of use |
+| Advanced Markdown Support   | Footnotes as sidenotes, YouTube embeds, task lists, Mermaid diagrams, math notation, tabbed content, and more |
+| Modern UI                   | Responsive design, dark mode, three-panel layout, HTMX navigation |
+| Interactive Diagrams       | Zoomable, pannable Mermaid diagrams with fullscreen support |
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install bloggy
+```
+
+### From source
+
+```bash
+git clone https://github.com/yeshwanth/bloggy.git
+cd bloggy
+pip install -e .
+```
+
+## Configuration
+
+Bloggy supports four ways to configure your blog (in priority order):
+
+1. cli arguments (e.g. `bloggy /path/to/markdown`) - Highest priority
+1. **[`.bloggy` configuration file](bloggy%20manual/configuration.md)** (TOML format)
+2. **Environment variables** - Fallback
+3. **Default values** - Final fallback
+
+## Bloggy Manual
+
+Short, focused guides for deeper topics. Start with configuration and writing content, then dive into architecture and advanced details.
+
+- [Configuration & CLI](bloggy%20manual/configuration.md)
+- [Markdown Writing Features](bloggy%20manual/markdown-features.md)
+- [Mermaid Diagrams](bloggy%20manual/mermaid-diagrams.md)
+- [Architecture Overview](bloggy%20manual/architecture.md)
+- [Theming & CSS](bloggy%20manual/theming.md)
+- [Security & Auth](bloggy%20manual/security.md)
+- [Advanced Behavior](bloggy%20manual/advanced.md)

bloggy-0.2.3.dist-info/RECORD

@@ -0,0 +1,13 @@
+bloggy/__init__.py,sha256=762R7tMFCoJX-ZnVeI2QvBmIL8PQdPvjGmE_MUPjuOc,158
+bloggy/build.py,sha256=m-GcYDSCtk5y-sTn1_8kOFlaGEv10GL9Uid2pgz52GQ,24218
+bloggy/config.py,sha256=5lcLFgnYkk-_o6_vGK-vaNk9vPJ-kOkGbnBJ9bGIUdc,4592
+bloggy/core.py,sha256=YNGysvlmqcvbcTS7GhjNQTUm72sVcDuBHp-30sFEjnU,100740
+bloggy/main.py,sha256=_WafOavniToqpyRVVwhIavhK6UBmzbuR3YKDHWRzvDE,4093
+bloggy/static/scripts.js,sha256=13OU0HVZJQRxU2GL-iWraw3Lh_IDeMlsL7cfIro_2b0,45131
+bloggy/static/sidenote.css,sha256=11XFyPV90fL4rzXfGHgjgOegBvKDqp-d3IWgiOwRVQI,1046
+bloggy-0.2.3.dist-info/licenses/LICENSE,sha256=xV8xoN4VOL0uw9X8RSs2IMuD_Ss_a9yAbtGNeBWZwnw,11337
+bloggy-0.2.3.dist-info/METADATA,sha256=fC_kTMgPWLUNKKpSQFAi5Ql7Qpumrq0DrQRTKQ6P2N0,7657
+bloggy-0.2.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+bloggy-0.2.3.dist-info/entry_points.txt,sha256=CNKjPiT6yMMEPbeyHXsiN0xHMwBqSo-kO3J5ClISDW4,43
+bloggy-0.2.3.dist-info/top_level.txt,sha256=YjR92iFE4BhzWG-Hg2l55N0xUNv5207y-daHjWja1aI,7
+bloggy-0.2.3.dist-info/RECORD,,