Docs

SuCoS is a minimalist Static Site Generator focused on simplicity and speed. It converts your Markdown content into a fully functional website, with minimal configuration required.

Prerequisites

None! SuCoS is distributed as a single executable file that works right out of the box.

Quick Start

  1. Install SuCoS following the installation guide.

  2. Create a new site:

sucos new-site ./my-site
cd my-site

  1. Add some content:

    • For a regular page: Create a file at content/pages/my-page.md
    • For a blog post: Create a file at content/blog/my-post.md

  2. Preview your site:

sucos serve

Then visit http://localhost:2341 in your browser to see your site.

  1. (Optional) Create a custom theme:
sucos new-theme

This will create a new theme in the themes directory that you can customize.

  1. (Optional) Publish your site:
    • Build the site: sucos build
    • The static files will be in the public directory
    • Deploy these files to your preferred hosting service

What's Next?

Docs