Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions grimoire/LESSONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
"# LESSONS LEARNED"
"1. The Jinja2 template processing can be tricky when CSS variables in HTML templates are involved, requiring careful escaping."
"2. Creating texture placeholder files is important for ensuring the frontend will work, even without the real assets."
"3. The combination of rich CLI output and markdown processing creates a powerful documentation tool experience."
127 changes: 127 additions & 0 deletions grimoire/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# 🔮 GRIMOIRE OF KNOWLEDGE

*"Transform your mundane documentation into a GRIMOIRE OF FORBIDDEN KNOWLEDGE!"*

A mad-science themed documentation generator that converts markdown files into a cohesive grimoire of arcane wisdom!

## ⚡ Features

- **Arcane Theming**: Choose from eldritch, steampunk, or cosmic themes!
- **Magical Transformations**: Regular markdown becomes enchanted with arcane symbols!
- **Living Documents**: Watch mode allows for real-time transmutation as you edit your markdown!
- **Cohesive Grimoire**: All your documentation is bound together with an arcane index!
- **Responsive Design**: Your grimoire adapts to any viewing portal!

## 🧙‍♂️ Installation

```bash
# Install the grimoire and its dependencies
pip install -r requirements.txt
```

## 🧪 Usage

### Basic Invocation

```bash
# Generate a grimoire from your docs
python -m grimoire.cli generate docs --output grimoire_output
```

### Watch Mode

```bash
# Generate and keep watching for changes
python -m grimoire.cli generate docs --output grimoire_output --watch
```

### Change Theme

```bash
# Generate with a different theme
python -m grimoire.cli generate docs --output grimoire_output --theme cosmic
```

### Create Templates

```bash
# Create template files for customization
python -m grimoire.cli create_template grimoire_templates
```

## 🔍 Available Themes

- **eldritch**: Ancient and mystical styling with parchment textures
- **steampunk**: Victorian-era industrial aesthetics with brass accents
- **cosmic**: Futuristic space theme with cosmic imagery

## 📜 Markdown Enhancements

The grimoire generator automatically enhances your markdown with:

- Arcane prefixes for headings
- Alchemical symbols for admonitions
- Random quotes from mad scientists
- Cohesive styling across all documents

## 🧰 Advanced Customization

Create your own templates by running:

```bash
python -m grimoire.cli create_template my_custom_templates
```

Then modify the HTML and CSS to your liking!

## 📚 Example

Turn this:

```markdown
# Project Overview

## Introduction

This is a simple project.

!!! note
Remember to check the configuration.

!!! warning
Don't run in production without testing!
```

Into this:

```markdown
# The Forbidden Secrets of Project Overview

## Experimental Protocols: Introduction

This is a simple project.

!!! note ⚗️
Remember to check the configuration.

!!! warning ☠️
Don't run in production without testing!
```

## 🔬 Contributing

Contributions are welcome from mad scientists of all experience levels!

## 📝 License

The Mad Scientific License (MSL-1.0)

---

*"The difference between madness and genius is measured only by success!"* "# TODO: Further Improvements"
""
"- Add support for dark mode in all themes"
"- Implement search functionality for the grimoire"
"- Add PDF export option"
"- Create more themes (e.g., 'necromancy', 'alchemy')"
"- Add interactive elements with JavaScript"
15 changes: 15 additions & 0 deletions grimoire/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
GRIMOIRE OF KNOWLEDGE
=====================
A mad-science themed documentation generator that
transmutes mundane markdown into an arcane grimoire!

Author: MadScientist-AI
Version: 0.1.0
License: The Mad Scientific License (MSL-1.0)
"""

from grimoire.grimoire import app, GrimoireGenerator, GrimoireTheme

__version__ = "0.1.0"
__all__ = ["app", "GrimoireGenerator", "GrimoireTheme"]
Binary file added grimoire/__pycache__/__init__.cpython-312.pyc
Binary file not shown.
Binary file added grimoire/__pycache__/cli.cpython-312.pyc
Binary file not shown.
Binary file added grimoire/__pycache__/grimoire.cpython-312.pyc
Binary file not shown.
Binary file added grimoire/assets/Cover-Art.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions grimoire/assets/brass.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions grimoire/assets/parchment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions grimoire/assets/stars.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions grimoire/cli.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#!/usr/bin/env python
"""
GRIMOIRE CLI
============
Command-line interface for the Grimoire documentation generator.
"""

import sys
from pathlib import Path
from grimoire.grimoire import app

if __name__ == "__main__":
app()
Loading