Help & Documentation

Getting Started

StaticPress is a WYSIWYG editor for Hugo static site blogs. It connects to your GitHub repository and lets you create and edit posts through a clean, visual interface.

Option 1: Create a New Blog

  1. Sign in with GitHub
  2. Click "Create New Blog" on the setup page
  3. Enter your blog name and description
  4. StaticPress creates a GitHub repository with Hugo pre-configured
  5. Start writing!

Option 2: Connect Existing Blog

  1. Sign in with GitHub
  2. Select your existing Hugo repository
  3. Set the content path (default: content/posts)
  4. Your existing posts will appear in the sidebar

Creating Posts

Writing a New Post

  1. Click the "New Post" button in the sidebar
  2. Enter a title for your post
  3. Write your content using the rich text editor
  4. Click "Publish" to make it live, or "Save Draft" to save without publishing

Editing Existing Posts

Click on any post in the sidebar to load it into the editor. Make your changes and click "Publish" to update the post on your site.

Deleting Posts

Hover over a post in the sidebar and click the delete icon. Confirm the deletion when prompted. This removes the post from your GitHub repository.

Editor Features

The StaticPress editor supports rich text formatting:

  • Bold and Italic text
  • Headings (H2, H3)
  • Bulleted and numbered lists
  • Block quotes
  • Code blocks
  • Horizontal rules
  • Links
  • Images (paid tiers)

Adding Images

With a paid subscription, you can add images to your posts:

  • Click the Image button in the toolbar
  • Or paste an image directly from your clipboard (Ctrl/Cmd+V)
  • Images are automatically uploaded to your GitHub repository

Deployment

Your Hugo blog can be deployed to various platforms. Here are the most popular options:

GitHub Pages (Easiest)

  1. Go to your repository Settings on GitHub
  2. Click "Pages" in the sidebar
  3. Under "Source", select "GitHub Actions"
  4. Your blog will deploy automatically on each push
  5. Access it at: username.github.io/repo-name

Cloudflare Pages

  1. Sign up at pages.cloudflare.com
  2. Connect your GitHub account
  3. Select your repository
  4. Set build command: hugo
  5. Set output directory: public

Vercel

  1. Sign up at vercel.com
  2. Import your GitHub repository
  3. Vercel auto-detects Hugo projects
  4. Click Deploy

Netlify

  1. Sign up at netlify.com
  2. Connect your GitHub repository
  3. Set build command: hugo
  4. Set publish directory: public

Subscription Tiers

Free

  • Edit your 5 most recent posts
  • Rich text editor
  • GitHub sync

Personal - $2.50/month

  • Edit all of your posts
  • Image uploads
  • Clipboard paste for images

Your own address - $5/month

  • Everything in Personal
  • Your own web address, with step-by-step help

FAQ

How does StaticPress work?

StaticPress connects to your GitHub repository and uses the GitHub API to read and write Markdown files. When you publish a post, it commits the file to your repo, which triggers your site to rebuild.

Is my data secure?

Yes. We use GitHub OAuth for authentication and only request the permissions needed to read and write to your repositories. Your posts are stored in your own GitHub repository.

Can I use StaticPress with an existing Hugo blog?

Absolutely! Select "Connect Existing Blog" on the setup page and choose your repository. Make sure to set the correct content path for where your posts are stored.

What Hugo themes are supported?

StaticPress works with any Hugo theme. The editor creates standard Markdown files with YAML frontmatter that Hugo expects.

How do I change my blog's theme or settings?

Edit the hugo.toml file in your repository directly on GitHub, or clone the repo locally and make changes there. StaticPress focuses on post editing.

Can I cancel my subscription?

Yes, you can cancel anytime from the Pricing page. You'll continue to have access until the end of your billing period, then revert to the Free tier.

Need More Help?

If you have questions not covered here, please reach out at support@staticpress.me