Clarislet

Getting Started with Clarislet

Fri, 06 Nov 2026 00:00:00 GMT

Install the template, start it locally and configure your site

In the folder containing package.json, install dependencies and start the development server.

Install and runsh

1pnpm install2pnpm dev

Make the site yours

Edit site.config.ts to change the name, author, homepage and deployment address. Use / as the base for a domain root, or /blog/ when hosting the blog in a subdirectory. The template can start with an empty content directory.

Choose a preview

Use pnpm dev while writing. Run pnpm build followed by pnpm preview to check the finished static pages and full-text search.

Next, create a private draft.

Write, Preview and Publish an Article

Fri, 06 Nov 2026 00:00:00 GMT

Create a Markdown draft and decide what readers can see

Create your first draft from the template root.

Create a draftsh

1pnpm new article first-note

Fill in the frontmatter

Article metadatayaml

1id: first-note2type: article3title: My first note4date: '2026-11-06'5status: draft6visibility: private7summary: A short explanation of what I learned.

Write below the frontmatter and keep the ID stable. A writing checklist demonstrates a relative attachment.

Preview locally

Stop the running development server. In PowerShell, set $env:CLARISLET_DRAFTS='1' and run pnpm dev. Remove the variable when returning to normal development.

Choose a visibility

Visibility	What visitors can see
public	Full article
private	No public entry
preview	Metadata and a limited opening

Use status: ready to release an eligible entry. For a partial preview, set ratio explicitly. The reading exercise shows the 10% case. Committed Markdown in a public repository can be read directly.

Introducing Clarislet

Fri, 06 Nov 2026 00:00:00 GMT

A tour of the template and its content files

Clarislet is a static blog template built with Astro. Write in Markdown and organize the same articles into topics and reference books.

What you can publish

Section	Purpose
Articles	Browse published writing
Topics	Follow a reading order
Library	Browse a collection of references
Notes	Publish short observations
Projects	Show finished work
Archive	Find articles by date

Start here

Markdown and Code Showcase

Sun, 18 Oct 2026 00:00:00 GMT

See Markdown, code, terminal output and notes rendered by the template

This page shows how common Markdown and GFM elements render.

Text and tasks

Use bold, emphasis, ~~strikethrough~~ and inline code where they help.

Write down the question before looking for an answer.

Identify the question
Add a reproducible example

Tables and images

Element	Purpose
Heading	Name a section
Table	Compare related information

Code and terminal output

reading-note.tstypescript

1const question = 'What does the example show?';2const answer = 'A reproducible Markdown example';3console.log(question, answer);

Keep the question next to the answer.

Example outputterminal

$ node reading-note.js
A reproducible Markdown example

Before running code

Check the filename and the context of the example first.

See Topics and Reference Books for stable links.

Topics and Reference Books

Fri, 12 Jun 2026 00:00:00 GMT

Organize articles using stable links, reading orders and nested chapters

A topic gives readers a suggested order. A reference book organizes entries into chapters. Both reuse the original content IDs.

Stable links and attachments

Use a link such as [First article](content:first-note) when the target exists. An article keeps its URL if its ID stays the same. Attachments use relative paths, so review those links after moving files.

Define a topic

knowledge/topics/first-steps.yamlyaml

1id: first-steps2title: First steps3intro: A short reading sequence4entries: [first-note]

Define a book

knowledge/books/my-handbook.yamlyaml

1id: my-handbook2title: My handbook3subtitle: Notes to revisit4intro: Useful explanations5theme: index6chapters:7  - title: Getting started8    children:9      - id: first-note

Run pnpm check after changing references.

Build, Deploy and Update

Mon, 27 Apr 2026 00:00:00 GMT

Publish the generated pages, assets and indexes together

The static site is generated under dist/public.

Check and buildsh

1pnpm check2pnpm build3pnpm preview

Publish the result

Use the correct base for the domain root or subdirectory. Deploy the full contents of dist/public together, including images and search indexes.

Release checklist

Review publication dates and visibility.
Check navigation, archives and search.
Open an image and a downloadable attachment.
Review a narrow screen and both color themes.

The optional owner service is configured separately. See the deployment guide in the template repository.

Reading Practice (10% Preview)

Thu, 16 Oct 2025 00:00:00 GMT

An example of a post that shows only its opening in the public build

The exercise

Read a paragraph and restate its main claim.

Clarislet

Getting Started with Clarislet

Make the site yours

Choose a preview

Write, Preview and Publish an Article

Fill in the frontmatter

Preview locally

Choose a visibility

Introducing Clarislet

What you can publish

Start here

Markdown and Code Showcase

Text and tasks

Tables and images

Code and terminal output

Topics and Reference Books

Stable links and attachments

Define a topic

Define a book

Build, Deploy and Update

Publish the result

Release checklist

Reading Practice (10% Preview)

The exercise

Restate the claim