vyasa 0.3.6__tar.gz

vyasa-0.3.6/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022, fastai
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vyasa-0.3.6/MANIFEST.in

@@ -0,0 +1,6 @@
+include settings.ini
+include LICENSE
+include README.md
+recursive-include vyasa/static *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

vyasa-0.3.6/PKG-INFO

@@ -0,0 +1,227 @@
+Metadata-Version: 2.4
+Name: vyasa
+Version: 0.3.6
+Summary: A lightweight, elegant blogging platform built with FastHTML
+Home-page: https://github.com/yeshwanth/vyasa
+Author: Yeshwanth
+Author-email: 
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/yeshwanth/vyasa
+Project-URL: Repository, https://github.com/yeshwanth/vyasa
+Project-URL: Issues, https://github.com/yeshwanth/vyasa/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.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
+Requires-Dist: pylogue>=0.3
+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"
+Provides-Extra: auth
+Requires-Dist: authlib>=1.3.0; extra == "auth"
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+---
+title: Vyasa
+---
+
+<p align="center">
+  <img src="static/icon.png" alt="Vyasa icon" class="vyasa-icon" style="width: 256px;">
+</p>
+
+<p class="vyasa-caption" style="text-align: center;">
+  Markdown feeds Python<br>
+  Instant sites, no code juggling<br>
+  CSS reigns supreme
+</p>
+
+
+---
+
+Vyasa is a Python-first blogging platform designed to turn your Markdown files into a fully-featured website in seconds. Write your content in clean, simple Markdown—no boilerplate, no configuration hassles—and watch your site come alive instantly. Whether you're a minimalist who wants it just to work or a CSS enthusiast ready to craft pixel-perfect designs, Vyasa adapts to your needs. Start with zero configuration and customize every pixel when you're ready.[^1]
+
+[^1]: If you're curious about how the intro was styled, [visit this page](https://github.com/sizhky/vyasa/blob/fa9a671931ad69b24139ba9d105bbadd8753b85b/custom.css#L36C1-L36C13).<br>
+    Check out the [Theming & CSS](vyasa%20manual/theming.md) guide for details on customizing your blog's appearance.
+
+---
+
+## Quick Start
+1. Install Vyasa:
+   ```bash
+   pip install vyasa
+   ```
+
+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.md
+   ```
+
+3. Run Vyasa:
+   ```bash
+   vyasa .
+   ```
+
+4. Open your browser at `http://127.0.0.1:5001`
+
+
+## Key Features
+
+```mermaid
+mindmap
+  root((🚀 Vyasa Features))
+    📝 Markdown
+      Footnotes as Sidenotes
+      YouTube Embeds
+      Task Lists
+      Math Notation
+      Superscript & Subscript
+      Strikethrough
+      Relative Links
+      Plain-Text Headings
+      Pandoc-style Attributes
+      Title Abbreviations
+      Folder Notes
+    🎨 Interactive Elements
+      Mermaid Diagrams
+        Flowcharts
+        Sequence Diagrams
+        State Diagrams
+        Gantt Charts
+      Interactive Diagrams
+        Zoom & Pan
+        Fullscreen Mode
+        Dark Mode Support
+        Auto-scaling
+      Tabbed Content
+      Custom CSS Cascade
+     UI/UX
+      Responsive Design
+      Dark Mode
+      Three-Panel Layout
+      HTMX Navigation
+      Collapsible Folders
+      Sidebar Search
+      Auto-Generated TOC
+      Mobile Menus
+      Sticky Navigation
+      Active Link Highlighting
+      PDF Support
+      Copy Button
+    ⚙️ Technical
+      FastHTML Foundation
+      Configuration File Support
+      CLI Arguments
+      Environment Variables
+      Security & Auth
+      Advanced Customization
+```
+
+### ✨ 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
+- **Title Abbreviations**: Configure `.vyasa` `abbreviations` to force uppercase acronyms in sidebar and slug-based titles (e.g., `ai-features` $\to$ `AI Features`)
+- **Folder Notes**: `index.md`, `README.md`, or `<folder>.md` can act as a folder summary; clicking the folder name opens it
+
+See the full list in [Markdown Writing Features](vyasa%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
+- **Inline Copy Button**: Copy raw markdown from a button placed right next to the post title
+- **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 vyasa
+```
+
+### From source
+
+```bash
+git clone https://github.com/yeshwanth/vyasa.git
+cd vyasa
+pip install -e .
+```
+
+## Configuration
+
+Vyasa supports four ways to configure your blog (in priority order):
+
+1. cli arguments (e.g. `vyasa /path/to/markdown`) - Highest priority
+1. **[`.vyasa` configuration file](vyasa%20manual/configuration.md)** (TOML format)
+2. **Environment variables** - Fallback
+3. **Default values** - Final fallback
+
+## Vyasa Manual
+
+Short, focused guides for deeper topics. Start with configuration and writing content, then dive into architecture and advanced details.
+
+- [Configuration & CLI](vyasa%20manual/configuration.md)
+- [Markdown Writing Features](vyasa%20manual/markdown-features.md)
+- [Mermaid Diagrams](vyasa%20manual/mermaid-diagrams.md)
+- [Architecture Overview](vyasa%20manual/architecture.md)
+- [Theming & CSS](vyasa%20manual/theming.md)
+- [Security & Auth](vyasa%20manual/security.md)
+- [Advanced Behavior](vyasa%20manual/advanced.md)

vyasa-0.3.6/README.md

@@ -0,0 +1,186 @@
+---
+title: Vyasa
+---
+
+<p align="center">
+  <img src="static/icon.png" alt="Vyasa icon" class="vyasa-icon" style="width: 256px;">
+</p>
+
+<p class="vyasa-caption" style="text-align: center;">
+  Markdown feeds Python<br>
+  Instant sites, no code juggling<br>
+  CSS reigns supreme
+</p>
+
+
+---
+
+Vyasa is a Python-first blogging platform designed to turn your Markdown files into a fully-featured website in seconds. Write your content in clean, simple Markdown—no boilerplate, no configuration hassles—and watch your site come alive instantly. Whether you're a minimalist who wants it just to work or a CSS enthusiast ready to craft pixel-perfect designs, Vyasa adapts to your needs. Start with zero configuration and customize every pixel when you're ready.[^1]
+
+[^1]: If you're curious about how the intro was styled, [visit this page](https://github.com/sizhky/vyasa/blob/fa9a671931ad69b24139ba9d105bbadd8753b85b/custom.css#L36C1-L36C13).<br>
+    Check out the [Theming & CSS](vyasa%20manual/theming.md) guide for details on customizing your blog's appearance.
+
+---
+
+## Quick Start
+1. Install Vyasa:
+   ```bash
+   pip install vyasa
+   ```
+
+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.md
+   ```
+
+3. Run Vyasa:
+   ```bash
+   vyasa .
+   ```
+
+4. Open your browser at `http://127.0.0.1:5001`
+
+
+## Key Features
+
+```mermaid
+mindmap
+  root((🚀 Vyasa Features))
+    📝 Markdown
+      Footnotes as Sidenotes
+      YouTube Embeds
+      Task Lists
+      Math Notation
+      Superscript & Subscript
+      Strikethrough
+      Relative Links
+      Plain-Text Headings
+      Pandoc-style Attributes
+      Title Abbreviations
+      Folder Notes
+    🎨 Interactive Elements
+      Mermaid Diagrams
+        Flowcharts
+        Sequence Diagrams
+        State Diagrams
+        Gantt Charts
+      Interactive Diagrams
+        Zoom & Pan
+        Fullscreen Mode
+        Dark Mode Support
+        Auto-scaling
+      Tabbed Content
+      Custom CSS Cascade
+     UI/UX
+      Responsive Design
+      Dark Mode
+      Three-Panel Layout
+      HTMX Navigation
+      Collapsible Folders
+      Sidebar Search
+      Auto-Generated TOC
+      Mobile Menus
+      Sticky Navigation
+      Active Link Highlighting
+      PDF Support
+      Copy Button
+    ⚙️ Technical
+      FastHTML Foundation
+      Configuration File Support
+      CLI Arguments
+      Environment Variables
+      Security & Auth
+      Advanced Customization
+```
+
+### ✨ 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
+- **Title Abbreviations**: Configure `.vyasa` `abbreviations` to force uppercase acronyms in sidebar and slug-based titles (e.g., `ai-features` $\to$ `AI Features`)
+- **Folder Notes**: `index.md`, `README.md`, or `<folder>.md` can act as a folder summary; clicking the folder name opens it
+
+See the full list in [Markdown Writing Features](vyasa%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
+- **Inline Copy Button**: Copy raw markdown from a button placed right next to the post title
+- **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 vyasa
+```
+
+### From source
+
+```bash
+git clone https://github.com/yeshwanth/vyasa.git
+cd vyasa
+pip install -e .
+```
+
+## Configuration
+
+Vyasa supports four ways to configure your blog (in priority order):
+
+1. cli arguments (e.g. `vyasa /path/to/markdown`) - Highest priority
+1. **[`.vyasa` configuration file](vyasa%20manual/configuration.md)** (TOML format)
+2. **Environment variables** - Fallback
+3. **Default values** - Final fallback
+
+## Vyasa Manual
+
+Short, focused guides for deeper topics. Start with configuration and writing content, then dive into architecture and advanced details.
+
+- [Configuration & CLI](vyasa%20manual/configuration.md)
+- [Markdown Writing Features](vyasa%20manual/markdown-features.md)
+- [Mermaid Diagrams](vyasa%20manual/mermaid-diagrams.md)
+- [Architecture Overview](vyasa%20manual/architecture.md)
+- [Theming & CSS](vyasa%20manual/theming.md)
+- [Security & Auth](vyasa%20manual/security.md)
+- [Advanced Behavior](vyasa%20manual/advanced.md)