hexo-theme-stellar 1.44.0 → 2.0.0-rc.2

package/README_EN.md

@@ -1,113 +1,106 @@
-# Stellar - Your Own Independent Blog
+<div align="center">
+  <img src="assets/icon-v2-x512.webp" width="160" alt="Stellar">
+  <h1>Stellar</h1>
+  <p>A blog that grows with your work</p>
+  <p>A complete, versatile, and feature-rich personal knowledge base designed to grow over time.</p>
+  <p><a href="README_EN.md">English</a> · <a href="README.md">简体中文</a></p>
+  <p>
+    <a href="https://github.com/xaoxuu/hexo-theme-stellar/releases"><img src="https://img.shields.io/github/v/release/xaoxuu/hexo-theme-stellar" alt="release"></a>
+    <a href="https://www.npmjs.com/package/hexo-theme-stellar"><img src="https://img.shields.io/npm/v/hexo-theme-stellar" alt="npm"></a>
+    <a href="https://www.npmjs.com/package/hexo-theme-stellar"><img src="https://img.shields.io/npm/dm/hexo-theme-stellar" alt="npm downloads"></a>
+    <a href="https://github.com/xaoxuu/hexo-theme-stellar"><img src="https://img.shields.io/github/stars/xaoxuu/hexo-theme-stellar" alt="stars"></a>
+    <a href="LICENSE"><img src="https://img.shields.io/github/license/xaoxuu/hexo-theme-stellar" alt="license"></a>
+  </p>
+  <p>
+    <a href="https://xaoxuu.com/wiki/stellar/start/install/">Create your first blog</a> ·
+    <a href="https://xaoxuu.com/wiki/stellar/support/examples/">Site examples</a> ·
+    <a href="https://xaoxuu.com/wiki/stellar/">Documentation</a>
+  </p>
+</div>
 
-[English](README_EN.md) · [简体中文](README.md)
+## Bring order to everything you publish
 
-[![npm](https://img.shields.io/npm/v/hexo-theme-stellar)](https://www.npmjs.com/package/hexo-theme-stellar)
-[![license](https://img.shields.io/github/license/xaoxuu/hexo-theme-stellar)](https://github.com/xaoxuu/hexo-theme-stellar/blob/main/LICENSE)
-[![stars](https://img.shields.io/github/stars/xaoxuu/hexo-theme-stellar)](https://github.com/xaoxuu/hexo-theme-stellar)
-[![npm downloads](https://img.shields.io/npm/dm/hexo-theme-stellar)](https://www.npmjs.com/package/hexo-theme-stellar)
-[![release](https://img.shields.io/github/v/release/xaoxuu/hexo-theme-stellar)](https://github.com/xaoxuu/hexo-theme-stellar/releases)
+> True simplicity is not just subtraction; it is creating order within complexity.
 
-Stellar is a Hexo theme that unifies blogging and knowledge base in one place. Beneath its clean, business-style aesthetics lie four built-in content systems — Blog, Wiki, Topic, and Notebook — plus a rich collection of tag plugins and dynamic data widgets, ready to use out of the box for every kind of expression.
+### A complete system for organizing content
 
-You can also use it as a lightweight blog theme from day one: install, enable, and start writing. Wiki, Topic, Notebook, and dynamic data widgets are all enabled on demand, growing naturally with your content needs.
+Start with regular posts. Give a project its own Wiki when it needs stable documentation, collect related posts into a Topic, and keep evolving knowledge in a Notebook. They share the same navigation, search, sidebars, and reading experience, while unused content systems stay out of the way.
 
-## Why Stellar
+### Flexible layout and expression
 
-### Four Content Systems, Integrated in One
+From appearance presets, colors, and type to columns, tabs, folding sections, and galleries, you can shape both the site and the way its content is presented. Local search can take readers directly to a matching section, while responsive layouts leave the main space to the article on narrow screens.
 
-- **Blog**: Two article layouts (tech / story) offer different reading experiences, with categories, tags, pagination, and related posts — use it as a lightweight blog right away if that's all you need.
-- **Wiki**: Showcase multiple project documentations or use it as your personal knowledge base, with project trees, sections, and hierarchical navigation.
-- **Topic**: Manage series of articles with an immersive, continuous reading experience.
-- **Notebook**: A three-layer architecture with a tag tree to organize, archive, and retrieve notes with ease.
+### Static pages that stay fresh
 
-All four systems and dynamic widgets are integrated out of the box — no need to assemble multiple plugins.
+Your writing preserves ideas while external data stays current. Remote content, community data, and external services can load on demand without being coupled to the static article, so frequently changing data does not require a full-site rebuild.
 
-### Expressive Tag Plugins
+## Site examples
 
-A large set of flexible and powerful tag plugins — notes, folding, tabs, timelines, galleries, icons, emoji, highlights, OKR, chat, tables, and more — that can be freely mixed and nested, freeing your content from the limits of plain Markdown. See the [tag plugins documentation](https://xaoxuu.com/wiki/stellar/tag-plugins/).
+[Stellar Examples](https://github.com/xaoxuu/hexo-theme-stellar-examples/) provides runnable sites you can explore before replacing their content and configuration at your own pace. Visit [Site examples](https://xaoxuu.com/wiki/stellar/support/examples/) for more real sites.
 
-### Dynamic Data Widgets
+## Get started
 
-Static blogs with dynamic capabilities — update content without redeploying:
-
-- **Dynamic timeline**: Post short updates like a social feed, or subscribe to others' timelines.
-- **Automated friend links**: Automatically detect link status, tag links, and subscribe to friends' posts.
-- **Remote Markdown rendering**: Render a project repository's README directly, avoiding duplicate maintenance.
-- **GitHub repository / contributor cards, ratings, votes, latest comments**, and other data widgets — loaded on demand without slowing down the first screen.
-- **Community culture**: Subscribe to the "Explorer" timeline data source to learn from the community.
+### Requirements
 
-### Experience & Performance
+- Node.js 22 or newer
+- Hexo 8 or newer
 
-- **Modular design**: Highly reusable widgets with freely configurable left/right sidebars.
-- **Design-token-driven styling**: A unified design language, dark mode, and responsive mobile adaptation.
-- **Lazy-loaded images** reserve space by original aspect ratio, preventing layout jumps.
-- Optional plugins enabled on demand: code highlighting & copy, KaTeX / MathJax, Mermaid diagrams, Fancybox lightbox, Swiper carousel, and more.
-- **Local search**: A built-in index generator, with results grouped by section, jumping to anchors and highlighting keywords.
-- **Complete SEO**: JSON-LD structured data, Open Graph, canonical URLs, and clone-site detection to protect original content.
-- **Multi-author support**: Assign different authors to different posts, each with their own dedicated homepage.
+### Create from a Blueprint
 
-Detailed usage for all of the above can be found in the [documentation](https://xaoxuu.com/wiki/stellar/).
+With Git and npm available, launch the interactive Blueprint installer with one command:
 
-## Examples & Showcase
+```bash
+sh -c "$(curl -fsSL https://github.com/xaoxuu/hexo-theme-stellar-examples/raw/main/install.sh)"
+```
 
-- Example source: [hexo-theme-stellar-examples](https://github.com/xaoxuu/hexo-theme-stellar-examples/) (`blog` blog scenario, `docs` documentation scenario) — ready to fork and start
-- Showcase: [Blogs using Stellar](https://xaoxuu.com/wiki/stellar/examples/)
+The installer reads the example repository's [`blueprints.json`](https://github.com/xaoxuu/hexo-theme-stellar-examples/blob/main/blueprints.json), presents the available Blueprints, then confirms the Blueprint, project directory, dependency installation, and creation plan.
 
-[![Star History Chart](https://star-history.dera.page/svg?repos=xaoxuu/hexo-theme-stellar&type=date&legend=top-left)](https://star-history.dera.page/#xaoxuu/hexo-theme-stellar&type=date&legend=top-left)
+### Install from npm
 
-## Quick Start
+Install the default version currently provided by npm, then confirm what was installed:
 
-### Requirements
-
-```yaml
-Hexo: 6.3.0 ~ latest (verified up to 8.1.2)
-hexo-cli: 4.3.0 ~ latest
-node: >= 22 # LTS recommended
-npm: >= 10
+```bash
+npm install hexo-theme-stellar
+npm ls hexo-theme-stellar
 ```
 
-### Install
+### Follow the latest source
 
-In the root directory of your blog:
+Add the official repository's `main` branch as a submodule and install the theme's own dependencies:
 
 ```bash
-npm install hexo-theme-stellar
+git submodule add -b main https://github.com/xaoxuu/hexo-theme-stellar.git themes/stellar
+npm install --prefix themes/stellar
 ```
 
-### Configure
+### Enable and check
 
-Edit `_config.yml` and enable the theme:
+Enable the theme in your site's `_config.yml`:
 
 ```yaml
 theme: stellar
 ```
 
-### Start Light
-
-Once configured, you can publish posts immediately. Wiki, Topic, Notebook, and dynamic widgets can be enabled on demand and are documented in detail; alternatively, start from the `blog` scenario in the example repository for a quick setup.
-
-## Documentation
-
-Full documentation: https://xaoxuu.com/wiki/stellar/ (currently available in Chinese)
+Then run Doctor and generate the site:
 
-> AI documentation: https://deepwiki.com/xaoxuu/hexo-theme-stellar/
-
-- Changelog: [CHANGELOG.md](https://github.com/xaoxuu/hexo-theme-stellar/blob/main/CHANGELOG.md) · [Releases](https://github.com/xaoxuu/hexo-theme-stellar/releases)
-
-### Common Topics
+```bash
+npx hexo stellar doctor
+npx hexo generate
+```
 
-- [Tag Plugins](https://xaoxuu.com/wiki/stellar/tag-plugins/)
-- [Theme Settings](https://xaoxuu.com/wiki/stellar/theme-settings/)
-- [Wiki System](https://xaoxuu.com/wiki/stellar/wiki-settings/)
-- [Topic & Notebook](https://xaoxuu.com/wiki/stellar/topic/)
+See [Installation](https://xaoxuu.com/wiki/stellar/start/install/) and [Create your first site](https://xaoxuu.com/wiki/stellar/start/first-site/) for the complete workflow.
 
-## Feedback
+## Documentation and community
 
-- Issues: https://github.com/xaoxuu/hexo-theme-stellar/issues/
-- Discussions: https://github.com/xaoxuu/hexo-theme-stellar/discussions/
-- Contributing: [CONTRIBUTING.md](CONTRIBUTING.md) · [Wiki contributors page](https://xaoxuu.com/wiki/stellar/contributors/)
+- [Configure your site](https://xaoxuu.com/wiki/stellar/start/configuration/)
+- [Use content components](https://xaoxuu.com/wiki/stellar/reference/tags/)
+- [Manage Wikis, Topics, and Notebooks](https://xaoxuu.com/wiki/stellar/reference/collection/)
+- [Theme configuration reference](https://xaoxuu.com/wiki/stellar/reference/theme/)
+- [Migrate from v1 to v2](https://xaoxuu.com/wiki/stellar/migration/v1-to-v2/)
+- [Issues](https://github.com/xaoxuu/hexo-theme-stellar/issues/) for reproducible problems
+- [Discussions](https://github.com/xaoxuu/hexo-theme-stellar/discussions/) for ideas and usage questions
+- [Contributing](CONTRIBUTING.md) for code and documentation work
 
 ## License
 
-This project is licensed under the [MIT License](LICENSE), Copyright (c) 2021 xaoxuu. Permanently open source and completely free.
+Stellar is free and open source under the [MIT License](LICENSE). Third-party licenses are listed in [THIRD-PARTY-NOTICES.md](legal/THIRD-PARTY-NOTICES.md).