docs: claude and readme
This commit is contained in:
158
README.md
Normal file
158
README.md
Normal file
@@ -0,0 +1,158 @@
|
||||
# ⚔️ Valknar's Digital Hall ⚔️
|
||||
|
||||
<div align="center">
|
||||
|
||||
|
||||
|
||||
### *Where Code Meets Art in the Digital Fjords*
|
||||
|
||||
[](https://pivoine.art)
|
||||
[](https://github.com/valknarogg/pivoine.art)
|
||||
[](https://jekyllrb.com/)
|
||||
[](https://nodejs.org/)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 🗡️ The Saga Begins
|
||||
|
||||
Welcome, traveler, to **pivoine.art** — the digital longship of **Valknar**, where the ancient spirit of the North meets modern craftsmanship. This is not merely a website; it is a **mead hall** of creativity, a **forge** of code, and a **gallery** of artistic expression.
|
||||
|
||||
Here you'll find tales of:
|
||||
- 🎨 **Art** — From the Devilish depths to the Souls of imagination
|
||||
- 💻 **Code** — Crafted with the precision of a master blacksmith
|
||||
- 🎵 **Music** — Echoes from distant realms
|
||||
- ✍️ **Stories** — Chronicles from Odinsland, Palina, and beyond
|
||||
|
||||
## ⚡ Features of the Hall
|
||||
|
||||
- **🌙 Dark Mode** — For those who prefer the shadows of Niflheim
|
||||
- **🔍 Intelligent Search** — Find your path through the archives
|
||||
- **🎭 Interactive Gallery** — Lightbox views worthy of Valhalla
|
||||
- **🎵 Sound Effects** — Immersive audio for the brave
|
||||
- **📱 Responsive Design** — Accessible across all devices, from desktop ravens to mobile drakkars
|
||||
- **⚡ Modern & Legacy Support** — Built with dual bundles for ancient (IE11+) and modern browsers
|
||||
|
||||
## 🏰 Architecture of the Fortress
|
||||
|
||||
This digital stronghold is built upon:
|
||||
|
||||
- **[Jekyll](https://jekyllrb.com/)** — The Ruby-forged static site generator
|
||||
- **[Pivoine Theme](https://hydecorp.github.io/hydejack/)** — A customized theme as beautiful as the Northern Lights
|
||||
- **Webpack** — Bundling JavaScript with the strength of Thor's hammer
|
||||
- **pnpm Workspaces** — Monorepo organization worthy of a jarl
|
||||
- **KaTeX** — Mathematical runes rendered with precision
|
||||
- **Web Components** — Modern browser magic using Lit
|
||||
|
||||
### The Tech Stack Runestones
|
||||
|
||||
```
|
||||
Frontend: TypeScript, Lit, RxJS, Web Components
|
||||
Backend: Jekyll (Ruby), Liquid Templates
|
||||
Styling: SCSS, Bootstrap-based Framework
|
||||
Build: Webpack, pnpm, Babel
|
||||
Deploy: GitHub Pages, GitHub Actions
|
||||
```
|
||||
|
||||
## 🛡️ Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before you embark on this journey, ensure you have:
|
||||
|
||||
- **Ruby** (with Bundler) — For Jekyll's ancient magic
|
||||
- **Node.js** (≥11) — For JavaScript sorcery
|
||||
- **pnpm** — The swift package manager
|
||||
|
||||
### Summoning the Site
|
||||
|
||||
```bash
|
||||
# Clone the longship
|
||||
git clone https://github.com/valknarogg/pivoine.art.git
|
||||
cd pivoine.art
|
||||
|
||||
# Gather the Ruby provisions
|
||||
bundle install
|
||||
|
||||
# Gather the JavaScript provisions
|
||||
pnpm install
|
||||
|
||||
# Forge the JavaScript and CSS artifacts
|
||||
pnpm run build:all
|
||||
|
||||
# Raise the sails (development server)
|
||||
bundle exec jekyll serve
|
||||
```
|
||||
|
||||
For auto-rebuilding during development:
|
||||
```bash
|
||||
# Terminal 1: Watch and rebuild assets
|
||||
pnpm run dev
|
||||
|
||||
# Terminal 2: Serve the site
|
||||
bundle exec jekyll serve
|
||||
```
|
||||
|
||||
## 🔨 Crafting Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|---------|---------|
|
||||
| `pnpm run build` | Build all JavaScript and CSS |
|
||||
| `pnpm run build:js` | Build JavaScript bundles (modern + legacy) |
|
||||
| `pnpm run build:css` | Build SCSS stylesheets |
|
||||
| `pnpm run dev` | Watch mode for development |
|
||||
| `pnpm run format` | Format JavaScript with Prettier |
|
||||
| `bundle exec jekyll serve` | Serve site locally |
|
||||
| `bundle exec jekyll build --lsi` | Build with related posts (LSI) |
|
||||
|
||||
## 📚 Content Realms
|
||||
|
||||
The chronicles are organized into sacred categories:
|
||||
|
||||
- **🎨 Palina** — Artistic visions
|
||||
- **⚔️ Odinsland** — Nordic-inspired works
|
||||
- **😈 Devilish** — Dark and provocative art
|
||||
- **👻 Souls** — Spiritual explorations
|
||||
- **✏️ Sketches** — Raw creativity
|
||||
- **🎵 Music** — Sonic journeys
|
||||
|
||||
## 🚀 Deployment
|
||||
|
||||
The site automatically deploys to [pivoine.art](https://pivoine.art) via GitHub Actions when changes are pushed to the main branch. The workflow builds both JavaScript assets and the Jekyll site, then publishes to GitHub Pages.
|
||||
|
||||
## 🎨 Customization
|
||||
|
||||
- **Theme Variables**: Edit `_sass/my-variables.scss`
|
||||
- **Custom Styles**: Modify `_sass/my-style.scss`
|
||||
- **Configuration**: Update `_config.yml`
|
||||
- **JavaScript**: Source files in `_js/src/`
|
||||
|
||||
## 🌐 Live Site
|
||||
|
||||
**Visit the hall:** [https://pivoine.art](https://pivoine.art)
|
||||
|
||||
Experience the fusion of code and creativity, where every pixel is placed with purpose and every line of code tells a story.
|
||||
|
||||
## 📜 License
|
||||
|
||||
© 2025 Valknar. All rights reserved.
|
||||
|
||||
## 🦅 The Falcon's Message
|
||||
|
||||
Like the falcon that swoops with precision and grace, this site is crafted with attention to detail and a commitment to excellence. May your journey through these digital halls be as thrilling as a Viking raid and as enlightening as the runes of old.
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
**⚔️ Crafted by Valknar ⚔️**
|
||||
|
||||
*Coding, Art, and Life*
|
||||
|
||||
[](https://twitter.com/bordeaux1981)
|
||||
[](https://github.com/valknarogg)
|
||||
|
||||
*"The wise warrior codes not with brute force, but with elegant solutions."*
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user