new-site
SuCoS new-site scaffolds a minimal site structure so you can start writing content immediately.
Usage
SuCoS new-site <path> [options]
The path argument is required and sets the output directory.
Options
| Option | Short | Default | Description |
|---|---|---|---|
--force |
-f |
off | Overwrite existing files |
--title |
"My Site" |
Site title written to sucos.yaml |
|
--description |
"" |
Site description | |
--url |
"https://example.org/" |
Base URL |
Examples
# Scaffold a site in ./my-blog
SuCoS new-site ./my-blog
# Scaffold with a title and URL
SuCoS new-site ./my-blog --title "My Blog" --url "https://myblog.example.com"
# Overwrite an existing directory
SuCoS new-site ./my-blog --force
Generated structure
my-blog/
├── content/ ← your Markdown files go here
├── static/ ← images, fonts, and other assets
├── themes/ ← one or more Liquid themes
└── sucos.yaml ← site configuration
After scaffolding, run:
cd my-blog
SuCoS serve
Your site is live at http://localhost:2341. Add a theme to see a styled result — see the theming guide or scaffold one with sucos new-theme.