midas-ssg 0.1.0__tar.gz

midas_ssg-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Niila Viinamäki
+
+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.

midas_ssg-0.1.0/PKG-INFO

@@ -0,0 +1,220 @@
+Metadata-Version: 2.4
+Name: midas-ssg
+Version: 0.1.0
+Summary: A minimal, opinionated static site generator
+Author: Niila Viinamäki
+License: MIT
+Project-URL: Homepage, https://midas.niila.fi
+Project-URL: Repository, https://github.com/vike256/Midas
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: markdown>=3.5
+Requires-Dist: Pygments>=2.16
+Requires-Dist: Jinja2>=3.1
+Requires-Dist: PyYAML>=6.0
+Dynamic: license-file
+
+# Midas
+
+A minimal, opinionated static site generator. Drop markdown files into a folder, run one command, and get a clean, fast, multilingual website.
+
+## Features
+
+- **Zero config** for single-language sites
+- **Markdown** with syntax highlighting, tables, and strikethrough
+- **Multilingual** support as a first-class feature
+- **RSS feeds** per language
+- **Built-in templates and CSS** that update with the package
+- **Jinja2 templates** — optional override for power users
+- **Built-in dev server** — no extra tools needed
+
+## Installation
+
+Requires Python 3.9 or newer.
+
+```bash
+pip install midas-ssg
+```
+
+Or install from source in editable mode for development:
+
+```bash
+pip install -e .
+```
+
+This installs the `midas` command-line tool.
+
+## Quick start
+
+```bash
+midas init my-blog
+cd my-blog
+midas serve
+```
+
+Open `http://localhost:8000` to see your site.
+
+## Commands
+
+| Command | Description |
+|---|---|
+| `midas init <folder>` | Scaffold a new Midas project into `<folder>`. Requires an empty directory. |
+| `midas init` | Scaffold a new Midas project into the current directory. Also requires an empty directory. |
+| `midas build` | Build the site to `dist/`. |
+| `midas serve` | Build and start a local development server on `http://localhost:8000`. |
+| `midas clean` | Delete the `dist/` folder. |
+
+## Directory structure
+
+After `midas init`, your project looks like this:
+
+```
+my-blog/
+├── midas.yaml          # Site configuration
+├── style.css           # Optional CSS overrides (empty by default)
+├── content/            # Your markdown content
+│   ├── index.md        # Homepage
+│   ├── posts/          # Blog posts
+│   └── img/            # Images (copied as-is)
+└── static/             # Other static assets (favicons, fonts, etc.)
+```
+
+The built site is written to `dist/`.
+
+## How it works
+
+### Templates
+
+Midas ships with built-in Jinja2 templates (`base.html`, `home.html`, `post.html`, etc.) that live inside the installed package. When you update Midas (`pip install -U midas`), your site's HTML updates automatically.
+
+You never have to touch HTML. If you want to customize a template, create a `templates/` folder in your project and copy only the files you want to override. Midas will use your version instead of the built-in one, but you'll stop receiving updates for those specific templates.
+
+### Styles
+
+Midas provides a built-in light minimalist stylesheet. It is copied to `dist/midas.css` on every build.
+
+To customize styles, edit the `style.css` file at your project root. It is copied to `dist/style.css` and loaded **after** `midas.css`, so any rule you write overrides the base. Keep your overrides minimal — only change what you need.
+
+For other assets (favicons, fonts, PDFs), drop them into `static/` and they are copied to `dist/`.
+
+## Writing content
+
+### Blog posts
+
+Create a markdown file in `content/posts/`:
+
+```markdown
+---
+title: "Hello World"
+description: "My first post"
+date: 2025-01-01
+---
+
+Your post content here.
+```
+
+Posts are sorted by date. The filename can also include a date prefix: `2025-01-01-hello-world.md`.
+
+### Standalone pages
+
+Any `.md` file outside `posts/` becomes a page:
+
+```markdown
+---
+title: "About"
+---
+
+This is the about page.
+```
+
+### Homepage
+
+`content/index.md` with `type: home` becomes the homepage. You can put metadata in its frontmatter or in `midas.yaml` under `home:`.
+
+### Multilingual content
+
+Add languages in `midas.yaml`:
+
+```yaml
+languages:
+  default: en
+  additional: [fi]
+```
+
+Then create content in `content/fi/posts/` for Finnish posts. Frontmatter `language` takes priority over folder inference.
+
+## Configuration
+
+`midas.yaml` is optional but recommended:
+
+```yaml
+site:
+  url: "https://example.com"
+  name: "My Site"
+  description: "A personal website"
+  copyright: "© 2024 Your Name"
+
+languages:
+  default: en
+  additional: [fi]
+
+home:
+  name: "Your Name"
+  bio: "A short description about you."
+  profilePic: "/img/profile.webp"
+  socials:
+    - name: github
+      url: "https://github.com/yourusername"
+    - name: email
+      url: "mailto:hello@example.com"
+  cards:
+    - title: "My Project"
+      url: "https://example.com/project"
+
+recentPosts: 3
+```
+
+## Customization
+
+### CSS overrides
+
+Edit `style.css` at your project root. For example, to switch to a dark background:
+
+```css
+body {
+  background: #1a1a1a;
+  color: #fafafa;
+}
+```
+
+### Template overrides
+
+Create a `templates/` folder and drop in only the files you want to override. For example, to customize the homepage:
+
+```bash
+mkdir templates
+cp $(python -c "import midas; print(midas.__file__)")/../templates/home.html templates/
+```
+
+Then edit `templates/home.html`. When you run `midas build`, you'll see a warning:
+
+```
+Templates overridden: home.html
+These will not receive updates from Midas automatically.
+```
+
+### Icons
+
+The built-in `home.html` template renders social icons by looking up SVG files in `templates/icons/` by name. If you create a `templates/icons/` folder in your project, you can add or replace icons there.
+
+## Dependencies
+
+- [markdown](https://pypi.org/project/Markdown/) — Markdown parsing
+- [Pygments](https://pygments.org/) — Syntax highlighting
+- [Jinja2](https://jinja.palletsprojects.com/) — Templating
+- [PyYAML](https://pyyaml.org/) — YAML parsing
+
+## License
+
+MIT

midas_ssg-0.1.0/README.md

@@ -0,0 +1,203 @@
+# Midas
+
+A minimal, opinionated static site generator. Drop markdown files into a folder, run one command, and get a clean, fast, multilingual website.
+
+## Features
+
+- **Zero config** for single-language sites
+- **Markdown** with syntax highlighting, tables, and strikethrough
+- **Multilingual** support as a first-class feature
+- **RSS feeds** per language
+- **Built-in templates and CSS** that update with the package
+- **Jinja2 templates** — optional override for power users
+- **Built-in dev server** — no extra tools needed
+
+## Installation
+
+Requires Python 3.9 or newer.
+
+```bash
+pip install midas-ssg
+```
+
+Or install from source in editable mode for development:
+
+```bash
+pip install -e .
+```
+
+This installs the `midas` command-line tool.
+
+## Quick start
+
+```bash
+midas init my-blog
+cd my-blog
+midas serve
+```
+
+Open `http://localhost:8000` to see your site.
+
+## Commands
+
+| Command | Description |
+|---|---|
+| `midas init <folder>` | Scaffold a new Midas project into `<folder>`. Requires an empty directory. |
+| `midas init` | Scaffold a new Midas project into the current directory. Also requires an empty directory. |
+| `midas build` | Build the site to `dist/`. |
+| `midas serve` | Build and start a local development server on `http://localhost:8000`. |
+| `midas clean` | Delete the `dist/` folder. |
+
+## Directory structure
+
+After `midas init`, your project looks like this:
+
+```
+my-blog/
+├── midas.yaml          # Site configuration
+├── style.css           # Optional CSS overrides (empty by default)
+├── content/            # Your markdown content
+│   ├── index.md        # Homepage
+│   ├── posts/          # Blog posts
+│   └── img/            # Images (copied as-is)
+└── static/             # Other static assets (favicons, fonts, etc.)
+```
+
+The built site is written to `dist/`.
+
+## How it works
+
+### Templates
+
+Midas ships with built-in Jinja2 templates (`base.html`, `home.html`, `post.html`, etc.) that live inside the installed package. When you update Midas (`pip install -U midas`), your site's HTML updates automatically.
+
+You never have to touch HTML. If you want to customize a template, create a `templates/` folder in your project and copy only the files you want to override. Midas will use your version instead of the built-in one, but you'll stop receiving updates for those specific templates.
+
+### Styles
+
+Midas provides a built-in light minimalist stylesheet. It is copied to `dist/midas.css` on every build.
+
+To customize styles, edit the `style.css` file at your project root. It is copied to `dist/style.css` and loaded **after** `midas.css`, so any rule you write overrides the base. Keep your overrides minimal — only change what you need.
+
+For other assets (favicons, fonts, PDFs), drop them into `static/` and they are copied to `dist/`.
+
+## Writing content
+
+### Blog posts
+
+Create a markdown file in `content/posts/`:
+
+```markdown
+---
+title: "Hello World"
+description: "My first post"
+date: 2025-01-01
+---
+
+Your post content here.
+```
+
+Posts are sorted by date. The filename can also include a date prefix: `2025-01-01-hello-world.md`.
+
+### Standalone pages
+
+Any `.md` file outside `posts/` becomes a page:
+
+```markdown
+---
+title: "About"
+---
+
+This is the about page.
+```
+
+### Homepage
+
+`content/index.md` with `type: home` becomes the homepage. You can put metadata in its frontmatter or in `midas.yaml` under `home:`.
+
+### Multilingual content
+
+Add languages in `midas.yaml`:
+
+```yaml
+languages:
+  default: en
+  additional: [fi]
+```
+
+Then create content in `content/fi/posts/` for Finnish posts. Frontmatter `language` takes priority over folder inference.
+
+## Configuration
+
+`midas.yaml` is optional but recommended:
+
+```yaml
+site:
+  url: "https://example.com"
+  name: "My Site"
+  description: "A personal website"
+  copyright: "© 2024 Your Name"
+
+languages:
+  default: en
+  additional: [fi]
+
+home:
+  name: "Your Name"
+  bio: "A short description about you."
+  profilePic: "/img/profile.webp"
+  socials:
+    - name: github
+      url: "https://github.com/yourusername"
+    - name: email
+      url: "mailto:hello@example.com"
+  cards:
+    - title: "My Project"
+      url: "https://example.com/project"
+
+recentPosts: 3
+```
+
+## Customization
+
+### CSS overrides
+
+Edit `style.css` at your project root. For example, to switch to a dark background:
+
+```css
+body {
+  background: #1a1a1a;
+  color: #fafafa;
+}
+```
+
+### Template overrides
+
+Create a `templates/` folder and drop in only the files you want to override. For example, to customize the homepage:
+
+```bash
+mkdir templates
+cp $(python -c "import midas; print(midas.__file__)")/../templates/home.html templates/
+```
+
+Then edit `templates/home.html`. When you run `midas build`, you'll see a warning:
+
+```
+Templates overridden: home.html
+These will not receive updates from Midas automatically.
+```
+
+### Icons
+
+The built-in `home.html` template renders social icons by looking up SVG files in `templates/icons/` by name. If you create a `templates/icons/` folder in your project, you can add or replace icons there.
+
+## Dependencies
+
+- [markdown](https://pypi.org/project/Markdown/) — Markdown parsing
+- [Pygments](https://pygments.org/) — Syntax highlighting
+- [Jinja2](https://jinja.palletsprojects.com/) — Templating
+- [PyYAML](https://pyyaml.org/) — YAML parsing
+
+## License
+
+MIT

midas_ssg-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "midas-ssg"
+version = "0.1.0"
+description = "A minimal, opinionated static site generator"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.9"
+authors = [{name = "Niila Viinamäki"}]
+dependencies = [
+    "markdown>=3.5",
+    "Pygments>=2.16",
+    "Jinja2>=3.1",
+    "PyYAML>=6.0",
+]
+
+[project.urls]
+Homepage = "https://midas.niila.fi"
+Repository = "https://github.com/vike256/Midas"
+
+[project.scripts]
+midas = "midas.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+midas = ["starter/**/*", "templates/**/*", "static/**/*"]

midas_ssg-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

midas_ssg-0.1.0/src/midas/__init__.py

@@ -0,0 +1,3 @@
+"""Midas — a minimal, opinionated static site generator."""
+
+__version__ = "0.1.0"

midas_ssg-0.1.0/src/midas/cli.py

@@ -0,0 +1,81 @@
+"""
+Midas — CLI entry point.
+"""
+
+import argparse
+import shutil
+import sys
+from pathlib import Path
+
+from importlib.resources import files
+
+from .core import build, serve, DIST_DIR
+from .defaults import load_config
+
+
+def _copy_tree(src, dst: Path) -> None:
+    """Recursively copy from importlib.resources Traversable to Path."""
+    for item in src.iterdir():
+        target = dst / item.name
+        if item.is_dir():
+            target.mkdir(exist_ok=True)
+            _copy_tree(item, target)
+        else:
+            target.write_bytes(item.read_bytes())
+
+
+STYLE_CSS_HEADER = """/* Override Midas base styles here.
+   This file is loaded after midas.css, so any rule here wins.
+   Delete this file if you don't need custom styles.
+*/
+"""
+
+
+def init_project(target: Path) -> None:
+    if target.exists() and any(target.iterdir()):
+        print(f"Error: {target} is not empty. Midas init requires an empty directory.")
+        print("Existing files in directory:")
+        for item in target.iterdir():
+            marker = " (dir)" if item.is_dir() else ""
+            print(f"  {item.name}{marker}")
+        sys.exit(1)
+
+    target.mkdir(parents=True, exist_ok=True)
+    starter = files("midas") / "starter"
+    _copy_tree(starter, target)
+
+    # Scaffold empty override files
+    (target / "style.css").write_text(STYLE_CSS_HEADER, encoding="utf-8")
+    (target / "static").mkdir(exist_ok=True)
+
+    print(f"Initialized Midas project in {target}")
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(description="Midas — static site generator")
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    init_parser = subparsers.add_parser("init", help="Initialize a new Midas project")
+    init_parser.add_argument("folder", nargs="?", default=".", help="Target directory")
+
+    subparsers.add_parser("build", help="Build the site to dist/")
+    subparsers.add_parser("serve", help="Build and serve on localhost:8000")
+    subparsers.add_parser("clean", help="Wipe dist/")
+
+    args = parser.parse_args()
+
+    if args.command == "init":
+        init_project(Path(args.folder))
+        return
+
+    if args.command == "clean":
+        if DIST_DIR.exists():
+            shutil.rmtree(DIST_DIR)
+        print("Cleaned dist/")
+        return
+
+    config = load_config()
+    build(config)
+
+    if args.command == "serve":
+        serve()