orbit-md 0.1.0

Fast static site generator with React-like Markdown components
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

# orbit-md

**Orbit** — a fast static site generator with **React-like components in Markdown**. Write pages in `.md` files, use JSX-style tags for UI components, and compile to production-ready HTML.

Install the CLI globally, scaffold a project, and build — just like Create React App.

## Install

```bash
cargo install orbit-md
```

Requires [Rust](https://rustup.rs/) 1.70+.

## Quick start

```bash
orbit init my-site
cd my-site
orbit dev
```

Open `http://127.0.0.1:3000` — edit files in `content/` and the site rebuilds automatically.

One-off build without the dev server:

```bash
orbit build
```

## Commands

| Command | Description |
|---|---|
| `orbit init <path>` | Scaffold a new project |
| `orbit init my-site --title "My Blog"` | Init with a custom site title |
| `orbit build` | Compile Markdown → HTML (`.orbit/`) |
| `orbit dev` | Local dev server with auto-rebuild on save |
| `orbit dev --open` | Dev server and open browser |
| `orbit dev --port 8080` | Dev server on a custom port |
| `orbit build --config orbit.yaml` | Build with a custom config path |
| `orbit new page blog/hello` | Create a new page under `content/` |

## Project structure

After `orbit init`, your site looks like this:

```
my-site/
├── orbit.yaml            # Site config
├── content/              # Markdown pages
│   └── index.md
├── components/           # Reusable UI components (Handlebars)
│   ├── Alert.hbs
│   ├── Button.hbs
│   └── Card.hbs
├── templates/            # Page layouts
│   └── base.hbs
└── .orbit/               # Generated HTML (after orbit build)
```

## Write pages with components

In any `.md` file under `content/`:

```md
---
title: Welcome
---

<Alert type="info" title="Hello">
You write **Markdown**, not HTML.
</Alert>

<Button href="/docs" label="Get started" />
```

Components live in `components/YourComponent.hbs` and are invoked with PascalCase JSX-style tags.

## Configuration

`orbit.yaml`:

```yaml
title: My Site
source_dir: content
output_dir: .orbit
template_dir: templates
components_dir: components
layout: base.hbs
```

## Publish to crates.io

```bash
cargo login          # one-time
cargo publish        # publishes crate `orbit-md`, installs as `orbit`
```

Users install with `cargo install orbit-md` and run the `orbit` command.

## Development

This repository is both the **Orbit tool source** and a demo site:

```bash
cargo run -- build          # build the demo site in ./.orbit
cargo test                  # run tests
```

## License

MIT