Admin Console Quick Guide

#Admin Console#guide 2,523 words about 8 minutes

TODO: describe this image

TODO: describe this image

TODO: describe this image

TODO: describe this image

The Admin Console at /admin/ is the local backend entry point, used after forking, cloning, or self-hosting to maintain site configuration and content.

It is not a standalone CMS. Saving writes back to the configuration or content files inside the repository, so it pairs well with Git: you can review diffs before and after changes, and roll back as normal project files when needed.

Local tools

The Admin Console’s editing features are only available in the development environment.
Production keeps at most a read-only site overview page; /api/admin/* serves only the local backend and is not a public API.

Quick entry

Start the project locally:

Bash
UTF-8|2 Lines|
npm install
npm run dev

The dev server runs at http://localhost:4321/ by default; if you changed the port, replace 4321 with your actual port.

EntryPageMain purpose
/admin/Site OverviewView the site overview, content structure, and recent articles
/admin/theme/Theme ConsoleEdit site info, sidebar, homepage, and inner-page copy
/admin/content/Content ConsoleArticle management and visual writing
/admin/images/Images ConsoleBrowse image resources and copy usable paths
/admin/checks/Checks ConsoleView structured diagnostics and run pre-release checks
/admin/data/Data ConsoleImport and export theme settings for migration and backup

Main pages

📈 Site Overview

Site Overview is the backend home, showing content counts, recent updates, and admin entry points (the entries are visible only in the development environment).

This page is optional and can be shown to visitors, controlled by the “Admin Overview” toggle inside the Theme Console.

🛠️ Theme Console

The Theme Console manages theme-level configuration, making it easy to adjust basic site settings after forking or cloning.

See the Theme Console configuration guide for details.

📝 Content Console

The Content Console is the entry point for content management and visual writing, where you can review and maintain the site’s written content in one place.

See the Content Console user guide for details.

🖼️ Images Console

The Images Console lets you browse image resources, inspect image info, and copy paths for use in configuration or content fields.

It is currently a resource browser: it does not compress, delete, or replace files. When you need to change an image, put it in the agreed project directory first, then return to the relevant page to select or fill in the path.

✅ Checks Console

The Checks Console runs pre-release checks, organizing content, configuration, image references, and agreed-upon risks into diagnostic results.

It does not modify files directly. When it finds an issue, go back to Theme, Content, or the source code to address it.

📤 Data Console

The Data Console handles importing or exporting theme settings. Export is for migration or backup; import runs a pre-check first and writes only after confirmation.

It works with the theme configuration data managed by the Theme Console, not with article content.


Those are the Admin Console’s main entries and features. If you have more ideas or suggestions, please open an Issue.