webolator 0.1.0__py3-none-win_amd64.whl

webolator-0.1.0.dist-info/METADATA

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: webolator
+Version: 0.1.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Documentation
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Topic :: Utilities
+License-File: LICENSE
+Summary: Zero-config markdown to website: folder or single file, mermaid, syntax highlighting, single-file HTML output
+Keywords: markdown,static-site,mermaid,documentation,cli
+Author-email: Ville Vainio <vivainio@gmail.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/vivainio/webolator
+Project-URL: Repository, https://github.com/vivainio/webolator
+
+# webolator
+
+Turn a folder of markdown, or a single `.md` file, into a browsable website. No config file, no index file, no `SUMMARY.md`.
+
+- **Zero config.** Point it at a folder and the navigation comes from the directory tree. Page titles come from the first `# heading`.
+- **Mermaid.** ```` ```mermaid ```` blocks become diagrams, rendered in the browser.
+- **Syntax highlighting** happens at build time (syntect), with light and dark themes and no JavaScript.
+- **Cross-file links work.** `other.md`, `dir/`, `../x.md#some-heading` and `/root/relative.md` are rewritten to the right pages and anchors. Broken links print a warning.
+- **Sibling files are kept.** Raw `.html`, `.txt`/`.log`/code files, PDFs and images are copied and linked. HTML, text and PDF files also appear in the sidebar.
+- **`--single`** writes one self-contained `.html` with everything embedded (images, text files, HTML files, PDFs), which is easy to email or attach.
+- **`--serve`** runs a local preview with live reload.
+- GitHub-flavored markdown: tables, task lists, footnotes, strikethrough, autolinks and `> [!NOTE]` alerts.
+- Light and dark mode follow the OS setting.
+
+## Installation
+
+### Using uv (easiest)
+
+Install the published wheel from PyPI as a standalone tool:
+
+```bash
+uv tool install webolator
+```
+
+This puts the `webolator` command on your PATH. To try it without installing anything:
+
+```bash
+uvx webolator docs/ --serve
+```
+
+### Pre-built binaries
+
+Download the latest release for your platform from the [GitHub Releases](https://github.com/vivainio/webolator/releases) page:
+
+- **Linux (x86_64)**: `webolator-linux-x86_64.tar.gz`
+- **Windows (x86_64)**: `webolator-windows-x86_64.zip`
+- **macOS (Intel)**: `webolator-macos-x86_64.tar.gz`
+- **macOS (Apple Silicon)**: `webolator-macos-arm64.tar.gz`
+
+Extract the archive and place the `webolator` binary in your PATH.
+
+### From source
+
+```bash
+cargo install --git https://github.com/vivainio/webolator
+```
+
+## Usage
+
+```bash
+webolator docs/                     # static site in ./site
+webolator docs/ -o public           # ...or somewhere else
+webolator docs/ --single            # one self-contained docs.html
+webolator notes.md --single         # a single file, plus anything it links to
+webolator docs/ --serve             # http://127.0.0.1:8000 with live reload
+```
+
+Try it on the bundled demo:
+
+```bash
+cargo run -- examples/demo --serve
+```
+
+### How the site is put together
+
+| Source | Result |
+|---|---|
+| `index.md` or `README.md` in a folder | that folder's `index.html` |
+| folder with no index | a generated listing page |
+| `foo.md` | `foo.html` (or `foo.md.html` if a raw `foo.html` already exists) |
+| any other file | copied as is |
+| hidden files and folders, `node_modules`, `target`, `venv` | skipped |
+
+If you pass a **single file**, webolator follows its local links, including links to parent folders. The site then contains that file, which becomes the home page, plus everything reachable from it.
+
+In **`--single` mode**, each page becomes a section with hash routing, so the back and forward buttons and deep links like `docs.html#p-guide-install--setup` work. Images are inlined. Linked HTML files are shown in an iframe and text files as preformatted text, and PDFs and other files open from embedded blobs.
+
+### Mermaid offline
+
+By default mermaid.js is loaded from the jsDelivr CDN, and only on pages that contain a diagram. To work fully offline, pass a local copy:
+
+```bash
+webolator docs/ --single --mermaid-js mermaid.min.js
+```
+
+In static mode the file is copied to `_webolator/`. In `--single` mode it is inlined.
+

webolator-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+webolator-0.1.0.data/scripts/webolator.exe,sha256=gtLbfttR-mput6XTng5qNHW6KYyEXKGhgnkpKAo6neQ,4092928
+webolator-0.1.0.dist-info/METADATA,sha256=sg4pzY_Z-8mlrUWAfK7Fo9l3BG4NZRp58bTf33bicxY,4603
+webolator-0.1.0.dist-info/WHEEL,sha256=8Aej0W0a6Cz6apA3IzJrTnxLRVLAt-w0Oh8SA3Con_c,94
+webolator-0.1.0.dist-info/licenses/LICENSE,sha256=F0DdnhtanxjHuAkXplJcOw1Ur_yto7F-G93mDrRa5Os,1090
+webolator-0.1.0.dist-info/sboms/webolator.cyclonedx.json,sha256=K3V5Wi94It9ZHJIbkZ0PHXaU-U2KoIFvUrHI3x8nQVI,94889
+webolator-0.1.0.dist-info/RECORD,,

webolator-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.15.0)
+Root-Is-Purelib: false
+Tag: py3-none-win_amd64

webolator-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ville Vainio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.