hexo README

The project's README from github.com/hexojs/hexo. As one markdown file: README.md.

Hexo logo

Hexo

A fast, simple & powerful blog framework, powered by Node.js.

Website | Documentation | Installation Guide | Contribution Guide | Code of Conduct | API | Twitter

NPM version Required Node version Build Status dependencies Status Coverage Status Gitter Discord Chat Telegram Chat FOSSA Status Contributor Covenant

Features

Quick Start

Install Hexo

$ npm install hexo-cli -g

Install with brew on macOS and Linux:

$ brew install hexo

Setup your blog

$ hexo init blog
$ cd blog

Start the server

$ hexo server

Create a new post

$ hexo new "Hello Hexo"

Generate static files

$ hexo generate

More Information

Contributing

We welcome you to join the development of Hexo. Please see contributing document. 🤗

Also, we welcome PR or issue to official-plugins.

Contributors

Backers

Backers

Sponsors

Sponsors

License

FOSSA Status

hexo (hexojs/hexo)

Searching Database…

41.8K ·GitHub
What is this?Hexo is a fast, simple and powerful blog framework powered by Node.js: you write posts in Markdown and it builds them into a complete static blog site.
Is it something that runs online, or a tool on my own machine?A tool on your own machine — a Node.js command-line app that generates static files you then host wherever you like; there is no server-side part to run or maintain.
How do I create and run my first blog?Install Hexo (brew on macOS and Linux, or npm), set up your blog, start the local server to preview it, create a new post, then generate the static files.
Do I need Node.js installed before I start?Yes — package metadata requires Node.js 20.19.0 or newer; the tool installs through npm, with a brew shortcut offered for macOS and Linux.
Which systems can I run it on?The README highlights macOS and Linux (brew install); since it is a plain Node.js CLI with no OS-specific dependencies, it also runs on Windows.
What is Hexo itself written in?The codebase is TypeScript, compiled with tsc and tested with mocha; it runs on Node.js 20.19+ and plugins interact with the core through its API.
Can a Hexo blog serve content in multiple languages?Yes — internationalization is built into the core: hexo-i18n ships as one of Hexo's core dependencies, which themes use for localized site text.
Creator
hexojs
Size
7.1 MB
Stars
41.8K
Age
14y
Commits · 90 Days