Write article: How to Generate a Slugkit Website with the slug CLI #15

New issue

Closed

opened 2026-06-27 14:43:43 -05:00 by erik · 3 comments

erik commented

2026-06-27 14:43:43 -05:00

Owner

Draft and publish a practical how-to article showing how to use the slug CLI to generate a new standalone Slugkit website.

Angle: slug init copies the Slugkit template into a new independent site project, applies basic identity placeholders, and leaves the generated site free to customize while preserving the Slugkit API contract.

Outline:

What slug init is for.
Prerequisites: Node.js, npm, Overmind, Docker/Compose if using local media storage.
Installing or running the slug CLI.
Running slug init to create a standalone site.
Choosing site name, URL, and local project directory.
What files/configuration are generated.
How to start the generated site locally.
Running diagnostics with slug doctor.
Editing site identity, homepage copy, theme, and public styling.
What not to edit casually: secrets, private keys, deployment config, database paths.
How preserving /api/v1 compatibility keeps shared tooling working.
Next steps: create drafts, publish posts, upload media, configure ActivityPub/federation when ready.

Draft and publish a practical how-to article showing how to use the `slug` CLI to generate a new standalone Slugkit website. Angle: `slug init` copies the Slugkit template into a new independent site project, applies basic identity placeholders, and leaves the generated site free to customize while preserving the Slugkit API contract. Outline: - What `slug init` is for. - Prerequisites: Node.js, npm, Overmind, Docker/Compose if using local media storage. - Installing or running the `slug` CLI. - Running `slug init` to create a standalone site. - Choosing site name, URL, and local project directory. - What files/configuration are generated. - How to start the generated site locally. - Running diagnostics with `slug doctor`. - Editing site identity, homepage copy, theme, and public styling. - What not to edit casually: secrets, private keys, deployment config, database paths. - How preserving `/api/v1` compatibility keeps shared tooling working. - Next steps: create drafts, publish posts, upload media, configure ActivityPub/federation when ready.

erik added the

labels

2026-06-27 14:43:43 -05:00

erik commented

2026-06-27 14:49:24 -05:00

Author

Owner

Synced from todu comment by @todu on 2026-06-27T19:47:13.064Z

Update

Drafted the article locally under articles/how-to-generate-a-slugkit-website-with-the-slug-cli/article.md.
Verified the draft has frontmatter and covers the required sections from the task.
Note: this directory is not currently a git repository, so I cannot complete the normal PR/merge/close pipeline from here.

_Synced from todu comment by @todu on 2026-06-27T19:47:13.064Z_ ### Update - Drafted the article locally under `articles/how-to-generate-a-slugkit-website-with-the-slug-cli/article.md`. - Verified the draft has frontmatter and covers the required sections from the task. - Note: this directory is not currently a git repository, so I cannot complete the normal PR/merge/close pipeline from here.

erik commented

2026-06-27 15:06:16 -05:00

Author

Owner

Synced from todu comment by @todu on 2026-06-27T20:04:49.066Z

Update

Uploaded banner media to slugkit.com at /media/posts/slug-cli-init/banner.png.
Created draft article slug-cli-init using the slug CLI.
Verified the post is an unpublished article draft with tags cli, how-to, and slugkit, and that the content references the uploaded banner image.

_Synced from todu comment by @todu on 2026-06-27T20:04:49.066Z_ ### Update - Uploaded banner media to `slugkit.com` at `/media/posts/slug-cli-init/banner.png`. - Created draft article `slug-cli-init` using the `slug` CLI. - Verified the post is an unpublished `article` draft with tags `cli`, `how-to`, and `slugkit`, and that the content references the uploaded banner image.

erik

2026-06-28 06:37:35 -05:00

closed this issue
added
status:done
and removed
status:inprogress
labels

erik commented

2026-06-28 06:37:35 -05:00

Author

Owner

Synced from todu comment by @todu on 2026-06-28T11:36:46.829Z

Completed

Published article slug-cli-init on slugkit.com.
Uploaded and referenced banner media at /media/posts/slug-cli-init/banner.png.
Verified the article is published with tags cli, how-to, and slugkit.

_Synced from todu comment by @todu on 2026-06-28T11:36:46.829Z_ ### Completed - Published article `slug-cli-init` on `slugkit.com`. - Uploaded and referenced banner media at `/media/posts/slug-cli-init/banner.png`. - Verified the article is published with tags `cli`, `how-to`, and `slugkit`.