Skip to content

πŸ“ SeigrKodeks – A standalone Markdown book creator with media embedding, automatic format conversion, and export to static HTML.

Notifications You must be signed in to change notification settings

Seigr-lab/SeigrKodeks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

8 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

SeigrKodeks - Structured Documentation for the Binary World

πŸ› οΈ Overview

SeigrKodeks is a desktop application developed within Seigr-lab for creating structured books and technical documentation in Markdown. Designed for binary-driven ecosystems, it provides a fully offline, structured, and media-integrated framework to write, manage, and export books.

With SeigrKodeks, you can:

  • πŸ“– Create books with structured chapters stored as Markdown.
  • ✍ Write in Markdown or MediaWiki, with seamless format conversion.
  • 🎨 Embed images, videos, and audio, keeping structured media organization.
  • 🌍 Export books as static HTML sites, preserving interlinked chapters.
  • πŸ–₯️ Run entirely offline, ensuring full control over documentation.

SeigrKodeks is built for:

βœ… Technical documentation in binary-driven environments.
βœ… Structured book-writing without cloud dependencies.
βœ… Offline, standalone documentation for specialized projects.
βœ… Future-proof Markdown-based documentation.


🎯 Why SeigrKodeks?

Most documentation tools:

  • Are web-based, requiring an internet connection (e.g., MkDocs, GitBook).
  • Lack structured media embedding, making multimedia-heavy books difficult.
  • Restrict users to specific formats, preventing seamless Markdown ↔ MediaWiki interoperability.

SeigrKodeks solves these issues by providing:
1️⃣ A standalone, offline-first approach – No browser, no web dependencies.
2️⃣ Flexible content management – Supports Markdown and MediaWiki.
3️⃣ Comprehensive media handling – Images, videos, and audio integrated into Markdown.
4️⃣ One-click export to structured static HTML – Books remain readable forever, no compatibility issues.


πŸ”„ How It Works

πŸ“˜ 1. Create & Manage Books

  • Define a book title and store it anywhere on your system.
  • Chapters are individual Markdown files, keeping content structured and portable.
  • Easily organize, rename, and edit chapters.

πŸ–Ό 2. Embed & Manage Media

SeigrKodeks supports seamless multimedia integration:

  • Images: ![Alt Text](media/image.jpg)
  • Videos: <video src="media/video.mp4" controls>
  • Audio: <audio src="media/audio.mp3" controls>
  • Media files are automatically stored in structured directories (media/).

🌍 3. Export as Static HTML

  • Generates a fully interactive website from your book.
  • The HTML output includes:
    βœ… A Table of Contents.
    βœ… Interlinked chapters with navigation.
    βœ… Embedded images, videos, and audio.
  • πŸ“‚ Perfect for hosting or local reading.

πŸ“¦ Project Structure

SeigrKodeks/
│── seigr_kodeks/                 # Core Framework
β”‚   β”œβ”€β”€ parsers/                   # Format detection & conversion
β”‚   β”‚   β”œβ”€β”€ format_detector.py      # Detects if content is Markdown or MediaWiki
β”‚   β”‚   β”œβ”€β”€ mediawiki_to_md.py      # Converts MediaWiki to Markdown
β”‚   β”œβ”€β”€ storage_manager.py          # Manages storage preferences & settings
β”‚   β”œβ”€β”€ file_manager.py             # Handles book file organization
β”‚   β”œβ”€β”€ media_manager.py            # Embeds and manages media
β”‚   β”œβ”€β”€ markdown_parser.py          # Processes Markdown content
β”‚   β”œβ”€β”€ html_renderer.py            # Converts Markdown to styled HTML
β”‚   β”œβ”€β”€ exporter.py                 # Handles full book export to HTML
β”‚   β”œβ”€β”€ desktop_gui.py              # The Tkinter-based GUI
│── books/                          # User-created books (each book is a directory)
│── output/                         # Exported HTML books
│── assets/                         # Shared resources (icons, UI elements)
│── requirements.txt                # Dependencies (minimal)
│── README.md                       # Documentation

πŸ›  Features

βœ… Fully Standalone Desktop Application – No browser, no cloud dependencies.
βœ… Multi-Format Support – Write in Markdown or MediaWiki, and export to HTML.
βœ… Full Book & Chapter Organization – Manage, reorder, and structure books easily.
βœ… Rich Media Embedding – Images, video, and audio seamlessly integrated.
βœ… One-Click HTML Export – Generate a fully linked static book site.
βœ… Minimal & Portable – Runs on Linux, WSL, and Windows.


πŸ”₯ Next Steps

βœ… Format Detection & Markdown Conversion
βœ… Fully Functional Desktop UI
βœ… Comprehensive Book & Chapter Management
βœ… Seamless Media Embedding & File Handling
βœ… Static HTML Export for Fully Linked Book Sites

πŸ“Œ Upcoming Features:

  • πŸ“œ PDF Export Support
  • 🌍 GitHub Integration for Book Hosting
  • πŸ“ WYSIWYG Markdown Editing Mode

πŸš€ SeigrKodeks & The Seigr Ecosystem

SeigrKodeks is a Seigr-lab project, developed to provide structured documentation solutions in the binary world.

πŸ”Ή It is NOT a part of Seigr OS but follows Seigr principles of structured, modular, and future-proof documentation.

πŸ”Ή It is built for offline-first, long-term technical writing, ensuring interoperability between Markdown, MediaWiki, and HTML.

πŸ”Ή While it aligns with the Seigr ecosystem, SeigrKodeks is an independent tool designed to function outside Seigr OS.


Final Notes

SeigrKodeks is built to simplify book creation while staying lightweight, portable, and powerful. It follows the Seigr philosophy of structured, secure, and future-proofed development.

About

πŸ“ SeigrKodeks – A standalone Markdown book creator with media embedding, automatic format conversion, and export to static HTML.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published