Skip to content

Commit f6a0cd1

Browse files
committed
Add product landing page with SEO for GitHub Pages
- Add docs/site/index.html with full SEO meta tags, Open Graph, Twitter Cards, JSON-LD - Add docs/site/style.css shared dark-theme design system - Add docs/site/robots.txt - Add .github/workflows/deploy-pages.yml for auto-deploy
1 parent da70c84 commit f6a0cd1

4 files changed

Lines changed: 344 additions & 0 deletions

File tree

.github/workflows/deploy-pages.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Deploy Product Page
2+
on:
3+
push:
4+
branches: [master]
5+
paths: ['docs/site/**']
6+
workflow_dispatch:
7+
permissions:
8+
pages: write
9+
id-token: write
10+
concurrency:
11+
group: pages
12+
cancel-in-progress: false
13+
jobs:
14+
deploy:
15+
environment:
16+
name: github-pages
17+
url: ${{ steps.deployment.outputs.page_url }}
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: actions/configure-pages@v4
22+
- uses: actions/upload-pages-artifact@v3
23+
with:
24+
path: docs/site
25+
- id: deployment
26+
uses: actions/deploy-pages@v4

docs/site/index.html

Lines changed: 233 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,233 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>ebuild — Unified Build System | EmbeddedOS</title>
7+
<meta name="description" content="Unified build system with 18 CLI commands, cross-compilation, SDK generation, package management with YAML recipes, and deployable OS image creation.">
8+
<meta name="keywords" content="build system, cli, cross-compilation, sdk, cmake, embedded, package manager">
9+
<meta name="author" content="EmbeddedOS Organization">
10+
<link rel="canonical" href="https://embeddedos-org.github.io/ebuild/">
11+
12+
<!-- Open Graph -->
13+
<meta property="og:type" content="website">
14+
<meta property="og:title" content="ebuild — Unified Build System | EmbeddedOS">
15+
<meta property="og:description" content="Unified build system with 18 CLI commands, cross-compilation, SDK generation, package management with YAML recipes, and deployable OS image creation.">
16+
<meta property="og:url" content="https://embeddedos-org.github.io/ebuild/">
17+
<meta property="og:site_name" content="EmbeddedOS">
18+
<meta property="og:image" content="https://embeddedos-org.github.io/assets/ebuild-og.png">
19+
20+
<!-- Twitter Card -->
21+
<meta name="twitter:card" content="summary_large_image">
22+
<meta name="twitter:title" content="ebuild — Unified Build System | EmbeddedOS">
23+
<meta name="twitter:description" content="Unified build system with 18 CLI commands, cross-compilation, SDK generation, package management with YAML recipes, and deployable OS image creation.">
24+
<meta name="twitter:image" content="https://embeddedos-org.github.io/assets/ebuild-og.png">
25+
26+
<!-- JSON-LD Structured Data -->
27+
<script type="application/ld+json">
28+
{
29+
"@context": "https://schema.org",
30+
"@type": "SoftwareApplication",
31+
"name": "ebuild",
32+
"alternateName": "Unified Build System",
33+
"description": "Unified build system with 18 CLI commands, cross-compilation, SDK generation, package management with YAML recipes, and deployable OS image creation.",
34+
"url": "https://embeddedos-org.github.io/ebuild/",
35+
"applicationCategory": "DeveloperApplication",
36+
"operatingSystem": "Linux, macOS, Windows",
37+
"offers": {
38+
"@type": "Offer",
39+
"price": "0",
40+
"priceCurrency": "USD"
41+
},
42+
"sourceOrganization": {
43+
"@type": "Organization",
44+
"name": "EmbeddedOS",
45+
"url": "https://embeddedos-org.github.io/"
46+
},
47+
"codeRepository": "https://github.com/embeddedos-org/ebuild"
48+
}
49+
</script>
50+
51+
<link rel="stylesheet" href="style.css">
52+
</head>
53+
<body>
54+
55+
<!-- Navbar -->
56+
<nav class="navbar">
57+
<div class="nav-inner">
58+
<a href="https://embeddedos-org.github.io/" class="logo">
59+
<div class="logo-icon" style="background: linear-gradient(135deg, #1a7a30, #3fb950);">eb</div>
60+
EmbeddedOS
61+
</a>
62+
<div class="nav-links">
63+
<a href="https://embeddedos-org.github.io/">Home</a>
64+
<a href="https://embeddedos-org.github.io/ebuild/" class="active">Docs</a>
65+
<a href="https://github.com/embeddedos-org/ebuild">GitHub</a>
66+
</div>
67+
</div>
68+
</nav>
69+
70+
<!-- Breadcrumb -->
71+
<div class="breadcrumb">
72+
<a href="https://embeddedos-org.github.io/">EmbeddedOS</a>
73+
<span class="sep">/</span>
74+
<span>ebuild</span>
75+
</div>
76+
77+
<!-- Hero -->
78+
<section class="hero" style="border-left: 4px solid #3fb950;">
79+
<div class="hero-content">
80+
<h1 style="background: linear-gradient(135deg, #3fb950, var(--purple), var(--pink)); -webkit-background-clip: text; -webkit-text-fill-color: transparent;">ebuild — Unified Build System</h1>
81+
<p class="subtitle">Unified build system with 18 CLI commands, cross-compilation, SDK generation, package management with YAML recipes, and deployable OS image creation.</p>
82+
<div class="hero-badges">
83+
<span class="badge badge-green">18 CLI Commands</span>
84+
<span class="badge badge-orange">Cross-Compilation</span>
85+
<span class="badge badge-blue">SDK Generation</span>
86+
<span class="badge badge-purple">Package Manager</span>
87+
<span class="badge badge-cyan">OS Images</span>
88+
</div>
89+
<div class="hero-buttons">
90+
<a href="https://github.com/embeddedos-org/ebuild" class="btn btn-primary" style="background: var(--green);">View on GitHub</a>
91+
<a href="https://github.com/embeddedos-org/ebuild/releases/tag/v0.2.0-book" class="btn btn-outline">Download Book (PDF)</a>
92+
</div>
93+
</div>
94+
</section>
95+
96+
<!-- Features -->
97+
<section class="section">
98+
<h2 class="section-title">Key Features</h2>
99+
<p class="section-subtitle">One tool to build, package, and deploy embedded firmware</p>
100+
<div class="feature-grid">
101+
<div class="feature-card" style="border-top: 3px solid #3fb950;">
102+
<h3>18 CLI Commands</h3>
103+
<p>Complete command-line interface covering init, build, flash, test, clean, package, deploy, sdk, image, and more — all from a single tool.</p>
104+
</div>
105+
<div class="feature-card" style="border-top: 3px solid #f0883e;">
106+
<h3>Cross-Compilation</h3>
107+
<p>Seamless cross-compilation with CMake, Make, Meson, and Cargo backends. Auto-detects and configures toolchains for ARM, RISC-V, Xtensa, and more.</p>
108+
</div>
109+
<div class="feature-card" style="border-top: 3px solid #58a6ff;">
110+
<h3>Hardware Schematic Analysis</h3>
111+
<p>Parse KiCad and Altium schematics to auto-generate pin maps, peripheral configs, and device tree overlays for your custom hardware.</p>
112+
</div>
113+
<div class="feature-card" style="border-top: 3px solid #bc8cff;">
114+
<h3>Yocto-Style SDK Generation</h3>
115+
<p>Generate self-contained, relocatable SDKs with cross-toolchain, sysroot, and headers for offline development and CI/CD pipelines.</p>
116+
</div>
117+
<div class="feature-card" style="border-top: 3px solid #79c0ff;">
118+
<h3>Package Management (YAML)</h3>
119+
<p>Declarative YAML recipes for packages with dependency resolution, version pinning, license checking, and reproducible builds.</p>
120+
</div>
121+
<div class="feature-card" style="border-top: 3px solid #f778ba;">
122+
<h3>6 Project Templates</h3>
123+
<p>Kickstart projects with templates for bare-metal, RTOS, Linux, hybrid, library, and bootloader — each with best-practice structure.</p>
124+
</div>
125+
<div class="feature-card" style="border-top: 3px solid #e3b341;">
126+
<h3>OS Image Creation</h3>
127+
<p>Build deployable OS images with partition tables, filesystem generation, bootloader integration, and signing — ready for production.</p>
128+
</div>
129+
<div class="feature-card" style="border-top: 3px solid #f85149;">
130+
<h3>Auto-Dependencies</h3>
131+
<p>Automatic dependency graph analysis with incremental rebuilds, parallel compilation, and build cache for faster iteration cycles.</p>
132+
</div>
133+
</div>
134+
</section>
135+
136+
<!-- Quick Start -->
137+
<div class="section-alt">
138+
<section class="section">
139+
<h2 class="section-title">Quick Start</h2>
140+
<p class="section-subtitle">Install ebuild and build your first project</p>
141+
<pre><code><span style="color: var(--text-muted);"># Clone and install</span>
142+
git clone https://github.com/embeddedos-org/ebuild.git
143+
cd ebuild
144+
pip install -e .
145+
146+
<span style="color: var(--text-muted);"># Build for Raspberry Pi 4 with AI and networking</span>
147+
ebuild build --target raspi4 --with eai,eni
148+
149+
<span style="color: var(--text-muted);"># Generate deployable image</span>
150+
ebuild image --format sdcard</code></pre>
151+
</section>
152+
</div>
153+
154+
<!-- API Highlights -->
155+
<section class="section">
156+
<h2 class="section-title">CLI Reference</h2>
157+
<p class="section-subtitle">Key commands at a glance</p>
158+
<table>
159+
<thead>
160+
<tr>
161+
<th>Command</th>
162+
<th>Description</th>
163+
<th>Example</th>
164+
</tr>
165+
</thead>
166+
<tbody>
167+
<tr>
168+
<td><code>ebuild init</code></td>
169+
<td>Initialize a new project from template</td>
170+
<td><code>ebuild init --template rtos</code></td>
171+
</tr>
172+
<tr>
173+
<td><code>ebuild build</code></td>
174+
<td>Build firmware for target board</td>
175+
<td><code>ebuild build --target stm32f4</code></td>
176+
</tr>
177+
<tr>
178+
<td><code>ebuild flash</code></td>
179+
<td>Flash firmware to connected device</td>
180+
<td><code>ebuild flash --port /dev/ttyUSB0</code></td>
181+
</tr>
182+
<tr>
183+
<td><code>ebuild sdk</code></td>
184+
<td>Generate relocatable SDK</td>
185+
<td><code>ebuild sdk --arch arm-cortex-m4</code></td>
186+
</tr>
187+
<tr>
188+
<td><code>ebuild package</code></td>
189+
<td>Create or install YAML packages</td>
190+
<td><code>ebuild package install mqtt</code></td>
191+
</tr>
192+
<tr>
193+
<td><code>ebuild image</code></td>
194+
<td>Build deployable OS image</td>
195+
<td><code>ebuild image --format emmc</code></td>
196+
</tr>
197+
<tr>
198+
<td><code>ebuild test</code></td>
199+
<td>Run unit and integration tests</td>
200+
<td><code>ebuild test --coverage</code></td>
201+
</tr>
202+
<tr>
203+
<td><code>ebuild schematic</code></td>
204+
<td>Analyze hardware schematics</td>
205+
<td><code>ebuild schematic parse board.kicad</code></td>
206+
</tr>
207+
</tbody>
208+
</table>
209+
</section>
210+
211+
<!-- Footer -->
212+
<footer class="footer">
213+
<div class="footer-inner">
214+
<div class="footer-grid">
215+
<a href="https://embeddedos-org.github.io/eos/">EoS — Embedded OS</a>
216+
<a href="https://embeddedos-org.github.io/eBoot/">eBoot — Bootloader</a>
217+
<a href="https://embeddedos-org.github.io/ebuild/">ebuild — Build System</a>
218+
<a href="https://embeddedos-org.github.io/eIPC/">eIPC — IPC Framework</a>
219+
<a href="https://embeddedos-org.github.io/eAI/">eAI — AI Framework</a>
220+
<a href="https://github.com/embeddedos-org/eos">GitHub — EoS</a>
221+
<a href="https://github.com/embeddedos-org/eBoot">GitHub — eBoot</a>
222+
<a href="https://github.com/embeddedos-org/ebuild">GitHub — ebuild</a>
223+
<a href="https://github.com/embeddedos-org/eIPC">GitHub — eIPC</a>
224+
<a href="https://github.com/embeddedos-org/eAI">GitHub — eAI</a>
225+
</div>
226+
<div class="footer-bottom">
227+
&copy; 2025 EmbeddedOS Organization. Open-source under the MIT License.
228+
</div>
229+
</div>
230+
</footer>
231+
232+
</body>
233+
</html>

docs/site/robots.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
User-agent: *
2+
Allow: /
3+
Sitemap: https://embeddedos-org.github.io/sitemap.xml

docs/site/style.css

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
:root {
2+
--bg-primary: #0d1117; --bg-secondary: #161b22; --bg-tertiary: #1c2128; --bg-card: #21262d; --bg-hover: #292e36;
3+
--text-primary: #e6edf3; --text-secondary: #8b949e; --text-muted: #6e7681;
4+
--border-color: #30363d; --border-light: #21262d;
5+
--blue: #58a6ff; --green: #3fb950; --purple: #bc8cff; --orange: #f0883e; --cyan: #79c0ff; --pink: #f778ba; --yellow: #e3b341; --red: #f85149;
6+
--blue-dim: rgba(88,166,255,0.15); --green-dim: rgba(63,185,80,0.15); --purple-dim: rgba(188,140,255,0.15); --orange-dim: rgba(240,136,62,0.15); --cyan-dim: rgba(121,192,255,0.15); --pink-dim: rgba(247,120,186,0.15); --yellow-dim: rgba(227,179,65,0.15); --red-dim: rgba(248,81,73,0.15);
7+
--gradient-hero: linear-gradient(135deg, #0d1117 0%, #161b40 30%, #1a1040 60%, #0d1117 100%);
8+
--shadow-sm: 0 1px 3px rgba(0,0,0,0.3); --shadow-md: 0 4px 12px rgba(0,0,0,0.4); --shadow-lg: 0 8px 24px rgba(0,0,0,0.5);
9+
--radius-sm: 6px; --radius-md: 10px; --radius-lg: 16px;
10+
--font-sans: 'Segoe UI', -apple-system, BlinkMacSystemFont, sans-serif;
11+
--font-mono: 'Cascadia Code', 'Fira Code', Consolas, monospace;
12+
--nav-height: 64px;
13+
}
14+
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
15+
html { scroll-behavior: smooth; font-size: 16px; }
16+
body { font-family: var(--font-sans); background: var(--bg-primary); color: var(--text-primary); line-height: 1.7; -webkit-font-smoothing: antialiased; }
17+
a { color: var(--cyan); text-decoration: none; transition: color 0.2s; }
18+
a:hover { color: var(--blue); text-decoration: underline; }
19+
h1, h2, h3, h4 { line-height: 1.3; }
20+
h2 { font-size: 1.6rem; margin: 2.5rem 0 1rem; padding-bottom: 0.5rem; border-bottom: 1px solid var(--border-color); }
21+
h3 { font-size: 1.25rem; margin: 2rem 0 0.75rem; }
22+
.navbar { position: sticky; top: 0; z-index: 1000; background: rgba(13,17,23,0.85); backdrop-filter: blur(12px); border-bottom: 1px solid var(--border-color); height: var(--nav-height); display: flex; align-items: center; padding: 0 2rem; }
23+
.nav-inner { max-width: 1200px; width: 100%; margin: 0 auto; display: flex; align-items: center; justify-content: space-between; }
24+
.logo { display: flex; align-items: center; gap: 10px; font-size: 1.15rem; font-weight: 700; color: var(--text-primary); text-decoration: none; }
25+
.logo:hover { text-decoration: none; color: var(--text-primary); }
26+
.logo-icon { width: 32px; height: 32px; background: linear-gradient(135deg, #1158a6, #58a6ff); border-radius: var(--radius-sm); display: flex; align-items: center; justify-content: center; font-weight: 900; font-size: 0.8rem; color: #fff; }
27+
.nav-links { display: flex; align-items: center; gap: 0.25rem; }
28+
.nav-links a { padding: 0.5rem 1rem; border-radius: var(--radius-sm); color: var(--text-secondary); font-size: 0.9rem; font-weight: 500; transition: all 0.2s; }
29+
.nav-links a:hover { color: var(--text-primary); background: var(--bg-tertiary); text-decoration: none; }
30+
.nav-links a.active { color: var(--blue); background: var(--blue-dim); }
31+
.breadcrumb { display: flex; align-items: center; gap: 0.5rem; font-size: 0.85rem; color: var(--text-muted); margin-bottom: 1.5rem; flex-wrap: wrap; padding: 1rem 2rem 0; max-width: 1200px; margin: 0 auto; }
32+
.breadcrumb a { color: var(--text-secondary); }
33+
.breadcrumb .sep { color: var(--text-muted); }
34+
.hero { background: var(--gradient-hero); padding: 5rem 2rem 4rem; text-align: center; position: relative; overflow: hidden; }
35+
.hero::before { content: ''; position: absolute; top: -50%; left: -50%; width: 200%; height: 200%; background: radial-gradient(circle at 30% 50%, rgba(88,166,255,0.08) 0%, transparent 50%), radial-gradient(circle at 70% 50%, rgba(188,140,255,0.08) 0%, transparent 50%); }
36+
.hero-content { position: relative; z-index: 1; max-width: 800px; margin: 0 auto; }
37+
.hero h1 { font-size: 3rem; font-weight: 800; margin-bottom: 1rem; }
38+
.hero .subtitle { font-size: 1.2rem; color: var(--text-secondary); margin-bottom: 2rem; }
39+
.hero-badges { display: flex; gap: 0.5rem; justify-content: center; flex-wrap: wrap; margin-bottom: 2rem; }
40+
.hero-buttons { display: flex; gap: 1rem; justify-content: center; flex-wrap: wrap; }
41+
.btn { display: inline-flex; align-items: center; gap: 8px; padding: 0.7rem 1.5rem; border-radius: var(--radius-sm); font-weight: 600; font-size: 0.95rem; cursor: pointer; transition: all 0.25s; border: none; text-decoration: none !important; }
42+
.btn-primary { background: var(--blue); color: #fff !important; }
43+
.btn-primary:hover { background: #79b8ff; box-shadow: 0 0 20px rgba(88,166,255,0.3); transform: translateY(-2px); }
44+
.btn-outline { background: transparent; border: 1px solid var(--border-color); color: var(--text-secondary) !important; }
45+
.btn-outline:hover { border-color: var(--blue); color: var(--blue) !important; background: var(--blue-dim); }
46+
.badge { display: inline-flex; align-items: center; padding: 2px 10px; border-radius: 20px; font-size: 0.72rem; font-weight: 600; letter-spacing: 0.3px; text-transform: uppercase; }
47+
.badge-blue { background: var(--blue-dim); color: var(--blue); }
48+
.badge-green { background: var(--green-dim); color: var(--green); }
49+
.badge-purple { background: var(--purple-dim); color: var(--purple); }
50+
.badge-orange { background: var(--orange-dim); color: var(--orange); }
51+
.badge-cyan { background: var(--cyan-dim); color: var(--cyan); }
52+
.badge-pink { background: var(--pink-dim); color: var(--pink); }
53+
.badge-yellow { background: var(--yellow-dim); color: var(--yellow); }
54+
.badge-red { background: var(--red-dim); color: var(--red); }
55+
.section { padding: 4rem 2rem; max-width: 1200px; margin: 0 auto; }
56+
.section-alt { background: var(--bg-secondary); }
57+
.section-title { font-size: 1.8rem; font-weight: 800; margin-bottom: 0.5rem; text-align: center; border: none; }
58+
.section-subtitle { color: var(--text-secondary); text-align: center; margin-bottom: 2rem; font-size: 1rem; }
59+
.feature-grid { display: grid; grid-template-columns: repeat(auto-fill, minmax(280px, 1fr)); gap: 1.5rem; }
60+
.feature-card { background: var(--bg-card); border: 1px solid var(--border-color); border-radius: var(--radius-md); padding: 1.5rem; transition: all 0.3s; }
61+
.feature-card:hover { transform: translateY(-4px); box-shadow: var(--shadow-lg); border-color: var(--text-muted); }
62+
.feature-card h3 { font-size: 1.1rem; margin: 0 0 0.5rem; border: none; }
63+
.feature-card p { color: var(--text-secondary); font-size: 0.9rem; margin: 0; }
64+
pre { background: var(--bg-secondary); border: 1px solid var(--border-color); border-radius: var(--radius-md); padding: 1.2rem 1.5rem; overflow-x: auto; font-family: var(--font-mono); font-size: 0.85rem; line-height: 1.7; margin: 1rem 0; }
65+
code { font-family: var(--font-mono); font-size: 0.85em; }
66+
:not(pre) > code { background: var(--bg-tertiary); padding: 2px 7px; border-radius: 4px; color: var(--cyan); }
67+
table { width: 100%; border-collapse: collapse; margin: 1rem 0; font-size: 0.9rem; }
68+
th { background: var(--bg-tertiary); padding: 0.75rem 1rem; text-align: left; font-weight: 600; font-size: 0.82rem; text-transform: uppercase; letter-spacing: 0.5px; border-bottom: 2px solid var(--border-color); }
69+
td { padding: 0.6rem 1rem; border-bottom: 1px solid var(--border-light); }
70+
tr:hover { background: rgba(255,255,255,0.04); }
71+
.footer { background: var(--bg-secondary); border-top: 1px solid var(--border-color); padding: 2rem; margin-top: 4rem; }
72+
.footer-inner { max-width: 1200px; margin: 0 auto; }
73+
.footer-grid { display: grid; grid-template-columns: repeat(auto-fill, minmax(150px, 1fr)); gap: 1rem; margin-bottom: 1.5rem; }
74+
.footer-grid a { color: var(--text-secondary); font-size: 0.85rem; padding: 0.3rem 0; display: block; }
75+
.footer-grid a:hover { color: var(--blue); }
76+
.footer-bottom { text-align: center; color: var(--text-muted); font-size: 0.8rem; padding-top: 1rem; border-top: 1px solid var(--border-color); }
77+
@media (max-width: 768px) {
78+
.hero h1 { font-size: 2rem; }
79+
.feature-grid { grid-template-columns: 1fr; }
80+
.nav-links { display: none; }
81+
.footer-grid { grid-template-columns: repeat(2, 1fr); }
82+
}

0 commit comments

Comments
 (0)