8000 docs(site): add GitHub Pages landing page by dmux · Pull Request #8 · dmux/minilake · GitHub
[go: up one dir, main page]

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/workflows/pages.yml
8000
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Pages

# Publishes the marketing site in `site/` to GitHub Pages
# (https://dmux.github.io/minilake/). Requires the repository's Pages source to
# be set to "GitHub Actions" -- Settings -> Pages -> Build and deployment.
on:
push:
branches: [main]
paths:
- "site/**"
- ".github/workflows/pages.yml"
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
deploy:
runs-on: ubuntu-latest

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- uses: actions/checkout@v4

- uses: actions/configure-pages@v5

- uses: actions/upload-pages-artifact@v3
with:
path: site

- id: deployment
uses: actions/deploy-pages@v4
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</p>

<p align="center">
<a href="https://github.com/dmux/minilake/blob/main/docs/index.md"><strong>Documentation</strong></a> · <a href="https://github.com/dmux/minilake">GitHub</a> · <a href="https://github.com/dmux/minilake/pkgs/container/minilake">Container Image (GHCR)</a>
<a href="https://dmux.github.io/minilake/"><strong>Website</strong></a> · <a href="https://github.com/dmux/minilake/blob/main/docs/index.md">Documentation</a> · <a href="https://github.com/dmux/minilake">GitHub</a> · <a href="https://github.com/dmux/minilake/pkgs/container/minilake">Container Image (GHCR)</a>
</p>

---
Expand Down
Empty file added site/.nojekyll
Empty file.
27 changes: 27 additions & 0 deletions site/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# `site/` — the project website

The landing page published to GitHub Pages at <https://dmux.github.io/minilake/>.

It is a single self-contained `index.html` (inline CSS and JS, no build step, no
dependencies) plus the images in `assets/`. Edit it and push to `main`; the
`Pages` workflow uploads this directory as-is.

Preview it locally with any static server:

```bash
python3 -m http.server 4599 --directory site
# http://localhost:4599
```

## Assets

| File | What it is |
|---|---|
| `assets/minilake-logo.png` | `minilake_logo.png` from the repo root, background knocked out and trimmed |
| `assets/og.png` | 1200×630 social preview card (`og:image`) |
| `assets/favicon-32.png`, `favicon-64.png`, `apple-touch-icon.png` | Icons derived from the same mark |

`.nojekyll` keeps GitHub from running the files through Jekyll.

Content on the page is drawn from `README.md`, `FEATURES.md` and `docs/` — when a
feature's status changes there, update the "Coverage" table here too.
Binary file added site/assets/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/assets/favicon-32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/assets/favicon-64.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/assets/minilake-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/assets/og.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,063 changes: 1,063 additions & 0 deletions site/index.html

Large diffs are not rendered by default.

Loading
0