$ hexo init [folder]
Initializes a website. If no folder is provided, Hexo will set up the website in the current directory.
$ hexo new [layout] <title>
Creates a new article. If no layout is provided, Hexo will use the default_layout from _config.yml. If the title contains spaces, surround it with quotation marks.
| Option | Description |
|---|---|
-p, --path |
Post path. Customize the path of the post. |
-r, --replace |
Replace the current post if existed. |
-s, --slug |
Post slug. Customize the URL of the post. |
By default, Hexo will use the title to define the path of the file. For pages, it will create a directory of that name and an index.md file in it. Use the --path option to override that behaviour and define the file path:
hexo new page --path about/me "About me"
will create source/about/me.md file with the title “About me” set in the front matter.
Please note that the title is mandatory. For example, this will not result in the behaviour you might expect:
hexo new page --path about/me
will create the post source/_posts/about/me.md with the title “page” in the front matter. This is because there is only one argument (page) and the default layout is post.
$ hexo generate
Generates static files.
| Option | Description |
|---|---|
-d, --deploy |
Deploy after generation finishes |
-w, --watch |
Watch file changes |
-b, --bail |
Raise an error if any unhandled exception is thrown during generation |
-f, --force |
Force regenerate |
-c, --concurrency |
Maximum number of files to be generated in parallel. Default is infinity |
$ hexo publish [layout] <filename>
Publishes a draft.
$ hexo server
Starts a local server. By default, this is at http://localhost:4000/.
| Option | Description |
|---|---|
-p, --port |
Override default port |
-s, --static |
Only serve static files |
-l, --log |
Enable logger. Override logger format. |
$ hexo deploy
Deploys your website.
| Option | Description |
|---|---|
-g, --generate |
Generate before deployment |
$ hexo render <file1> [file2] ...
Renders files.
| Option | Description |
|---|---|
-o, --output |
Output destination |
$ hexo migrate <type>
Migrates content from other blog systems.
$ hexo clean
Cleans the cache file (db.json) and generated files (public).
$ hexo list <type>
Lists all routes.
$ hexo version
Displays version information.
$ hexo --safe
Disables loading plugins and scripts. Try this if you encounter problems after installing a new plugin.
$ hexo --debug
Logs verbose messages to the terminal and to debug.log. Try this if you encounter any problems with Hexo. If you see errors, please raise a GitHub issue.
$ hexo --silent
Silences output to the terminal.
$ hexo --config custom.yml
Uses a custom config file (instead of _config.yml). Also accepts a comma-separated list (no spaces) of JSON or YAML config files that will combine the files into a single _multiconfig.yml.
$ hexo --config custom.yml,custom2.json
$ hexo --draft
Displays draft posts (stored in the source/_drafts folder).
$ hexo --cwd /path/to/cwd
Customizes the path of current working directory.