Siteforge

Documentation

Siteforge docs

A Siteforge path from site config and content directories to theme extension and Agent discovery.

Get started

Run the site first, then enter the theme

Siteforge follows the same practical path as many documentation sites: confirm site-level config and content directories first, then move into theme files by page type.

config.ymlcontent/themes/<name>dist

Direct use

Use directly

If you are writing a blog or maintaining an ordinary content site, you do not need to learn theme development first.

  1. Clone.git clone https://github.com/jsw-teams/siteforge.git
  2. Enter.cd siteforge
  3. Install.npm install
  4. Check first.npm run check verifies output, theme assets, and discovery resources.
  5. Generate.npm run generate is similar to hexo generate / hexo g.
  6. Preview.npm run server is similar to hexo server / hexo s; default URL: http://127.0.0.1:4173/.

Files you usually edit

Start with config.yml: site name, languages, navigation, robots, llms, feed, discovery, and third-party scripts become structured inputs there.

Put content in content/: ordinary pages use content/pages, product docs use content/docs, and posts or mirrors continue to use their content directories.

Put theme work in themes/<name>: visual language, docs navigation, search styling, consent, lightbox, carousel, and footer behavior should be solved in the theme layer first.

Documentation

Read by stage

Get started Siteforge docs A Siteforge path from site config and content directories to theme extension and Agent discovery. Basic operations Pages and dynamic slots Use content/pages and Siteforge slots to customize home, search, and special pages with low cost. Deploy Deploy and publish Generate static files, check dist output, and verify site-operation resources before deployment. Customize Customize the default theme Use the default theme directly; replace content and source-assets first when branding is needed. Secondary development Theme development boundaries Develop product and documentation themes through Siteforge's theme-first workflow. Other Troubleshooting Reserved for common issues, edge cases, and usage boundaries.