Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SquishMark Starter

A starter template for creating a blog with SquishMark.

Getting Started

1. Use this template

Click the "Use this template" button above to create your own content repository.

2. Write your content

Add posts to the posts/ directory:

---
title: My First Post
date: 2026-01-25
tags: [hello, world]
draft: false
---

Your post content in Markdown...

Add pages to the pages/ directory:

---
title: About Me
---

This is a static page.

3. Deploy SquishMark

Follow the getting started guide to deploy your blog.

Repository Structure

your-content-repo/
├── posts/                    # Blog posts
│   ├── 2026-01-01-welcome.md
│   └── 2026-01-15-getting-started.md
├── pages/                    # Static pages
│   └── about.md
├── static/                   # Favicon, images, anything served as-is
│   └── favicon.svg
├── theme/                    # Custom theme overrides (optional)
│   └── ...
└── config.yml                # Site configuration

Configuration

Edit config.yml to customize your site:

site:
  title: "My Blog"
  description: "A blog about things"
  author: "Your Name"
  url: "https://yourdomain.com"

theme:
  name: default
  pygments_style: monokai

posts:
  per_page: 10

Frontmatter reference

The full field list lives at squishmark.dev/docs/frontmatter. The essentials:

Posts

---
title: Post Title          # Required
date: 2026-01-25           # Required (YYYY-MM-DD)
tags: [tag1, tag2]         # Optional
draft: false               # Optional (default: false)
description: "A summary"   # Optional (for SEO/previews)
---

Pages

---
title: Page Title          # Required
description: "A summary"   # Optional
---

Custom Themes

To customize the look of your blog, create a theme/ directory with Jinja2 templates:

theme/
├── base.html      # Base layout
├── index.html     # Post listing
├── post.html      # Single post
├── page.html      # Static page
└── static/
    └── style.css  # Your styles

See the theming guide for details.

License

MIT License - see LICENSE for details.

About

Starter template for creating a SquishMark blog

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors