diff --git a/README.md b/README.md index eeba8ed..cae252e 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,13 @@ Two themes ship with the package: `minimal` for small sites and `blog` for dated posts. A project can override a bundled theme by creating `themes//` inside the project; local themes take precedence. +| Blog | Handbook | +| --- | --- | +| ![The blog theme: a centred masthead followed by dated posts with summaries](https://raw.githubusercontent.com/jamstackpy/jamstack/stable/docs/assets/showcase/blog.png) | ![The handbook theme: a documentation layout with a sidebar and previous and next links](https://raw.githubusercontent.com/jamstackpy/jamstack/stable/docs/assets/showcase/handbook.png) | + +See the [showcase](https://jamstackpy.github.io/showcase/) for all four example +sites, each linked to its source under `examples/`. + Themes are plain folders, so a custom theme is just a directory with a `theme.toml`, `templates/`, and optionally `static/` and `scaffold/`. See [docs/themes.md](docs/themes.md) for the full specification. diff --git a/docs/assets/showcase/atlas.png b/docs/assets/showcase/atlas.png new file mode 100644 index 0000000..9473e99 Binary files /dev/null and b/docs/assets/showcase/atlas.png differ diff --git a/docs/assets/showcase/blog.png b/docs/assets/showcase/blog.png new file mode 100644 index 0000000..505c6da Binary files /dev/null and b/docs/assets/showcase/blog.png differ diff --git a/docs/assets/showcase/handbook.png b/docs/assets/showcase/handbook.png new file mode 100644 index 0000000..0f15f2c Binary files /dev/null and b/docs/assets/showcase/handbook.png differ diff --git a/docs/assets/showcase/minimal.png b/docs/assets/showcase/minimal.png new file mode 100644 index 0000000..7429b7e Binary files /dev/null and b/docs/assets/showcase/minimal.png differ diff --git a/docs/showcase.md b/docs/showcase.md new file mode 100644 index 0000000..e691562 --- /dev/null +++ b/docs/showcase.md @@ -0,0 +1,34 @@ +# Showcase + +Four sites built with the same engine. Each one lives under +[`examples/`](https://github.com/jamstackpy/jamstack/tree/stable/examples) and +is compiled in CI, so these screenshots match what the code produces. + +## Minimal + +[![The minimal theme: a single centred column with a title and one paragraph](assets/showcase/minimal.png)](https://github.com/jamstackpy/jamstack/tree/stable/examples/minimal) + +The smallest possible site: one Markdown page and the bundled `minimal` theme. +A good starting point for a landing page. + +## Blog + +[![The blog theme: a centred masthead followed by dated posts with summaries](assets/showcase/blog.png)](https://github.com/jamstackpy/jamstack/tree/stable/examples/blog) + +Dated posts, a feed and a sitemap. Shows the `blog` theme and how `date` and +`summary` shape the index. + +## Atlas + +[![The atlas theme: a local theme with a navigation bar, a hero and a grid of guides](assets/showcase/atlas.png)](https://github.com/jamstackpy/jamstack/tree/stable/examples/atlas) + +A local theme copied into the project: nested routes, a guide index, reading +time computed in Jinja, template and static overrides, and a themed 404. + +## Handbook + +[![The handbook theme: a documentation layout with a sidebar and previous and next links](assets/showcase/handbook.png)](https://github.com/jamstackpy/jamstack/tree/stable/examples/handbook) + +A documentation layout with a sidebar built from front matter (`section`, +`order`), a configurable section order through `[extra.sidebar]`, +previous/next links and footer content from `[extra]`. diff --git a/mkdocs.yml b/mkdocs.yml index 7b9869a..ae7214b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,6 +51,7 @@ markdown_extensions: nav: - Home: index.md + - Showcase: showcase.md - Tutorial: tutorial.md - Content: content.md - Configuration: configuration.md