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

---
title: Getting Started
description: Learn how to use JSX-style components in Markdown.
---

# Getting Started

Write pages in Markdown and drop in reusable components — just like React, but static.

<Card title="Quick Example">

<Alert type="warning" title="Tip">
Nest components freely. Inner Markdown is compiled automatically.
</Alert>

Use self-closing tags for simple widgets:

<Button href="/" label="Back home" />

</Card>

## How it works

1. Create a component in `components/YourComponent.hbs`
2. Use it in any `.md` file with JSX-style tags (see the Alert example above)
3. Run `orbit build` — HTML lands in `.orbit/`

## Commands

| Command | Description |
|---|---|
| `orbit dev` | Local dev server with watch-and-rebuild |
| `orbit build` | Compile Markdown pages to HTML |
| `orbit new page path/to/page.md` | Create a new Markdown page |
| `orbit init my-site` | Scaffold a new project |