Skip to content

Latest commit

 

History

History
119 lines (74 loc) · 5.86 KB

README_en.md

File metadata and controls

119 lines (74 loc) · 5.86 KB
Raw

English | 中文简体

Fluid Logo

An elegant Material-Design theme for Hexo

GitHub release (latest by date) Hexo version Contributors License

ScreenShot

Live Preview

Rook1e's blog

zkqiang's blog

Docs

Detailed configuration

Changelog

Article configuration

Notice

⚠️ This announcement is for older users and new users can ignore it.

Starting with the v1.4.0 version, the project was officially renamed to Fluid (original project name: Material-T), and the repository and ownership were transferred to the Fluid-dev organization, so git remote url, theme directory name and related code will change.

If you plan to upgrade v1.4.0, it is recommended to do the following:

  1. Unzip the release package and rename it to fluid (It is recommended that the user using the master branch re-clone the repository)
  2. Modify the blog root _config.yml configuration theme: fluid
  3. Copy the modified part of _config.yml of the original Material-T, or follow Smooth upgrade to use the configuration override feature.

We apologize for the inconvenience caused by the change.

Quick Start

1. Get the latest version

Please download the latest release version first, and the master branch cannot guarantee stability.

After downloading, extract it to the themes directory and rename it to fluid.

2. Necessary configuration

Modify _config.yml in the root directory as follows:

# Set the language, you need to correspond to the file name in the following directory, you can customize the file content.
# https://github.com/fluid-dev/hexo-theme-fluid/tree/master/languages
language: en

# Turn off default highlighting
highlight:
  enable: false

3. Enable theme

Still the _config.yml in the root directory, modified as follows:

# Extensions
theme: fluid

Smooth upgrade

Starting with v1.4.0, you can use Hexo data files to host theme configurations:

  1. Go to the site's /source/_data/ directory (note: not the source directory of the theme), create _data directory if it did not exist.
  2. Create fluid_config.yml and copy the modified or all configuration items from the theme configuration file into it. In this way, configuration item in fluid_config.yml will automatically override the theme's _config.yml when hexo g and will not be lost after updating the theme.
  3. Move your custom resource files (head_img, about.md, etc.) to site's source folder (don't forget to change the reference address for the resource in the configuration file)
  4. (v1.5.0 version and above) If you need to use a CDN or other means to store static resources: Copy theme's _static_prefix.yml to site's /source/_data/, rename it to fluid_static_prefix.yml and modify its configuration. If _data/fluid_static_prefix.yml exists, it will automatically overwrite theme's _static_prefix.yml.

After completing the above steps, in the future update, you only need to overwrite the theme/fluid folder with the new release.

FAQ

Code highlighting exception

  • Please confirm that the above "Turn off default highlighting" step has been completed.
  • Try "clean" command: hexo clean && hexo g hexo clean && hexo g

Configuration cannot take effect

  • Please check if the configuration file conforms to the yml syntax, such as spaces after the colon, 2 spaces for indentation, etc.

Contributing

If you are contributing for the first time, you can first claim a smaller task in the help wanted to quickly participate in community contributions. You can respond to the willingness to participate directly in the issue, then follow the GitHub workflow guidelines below to resolve the issue and submit the PR according to the specification, and after reviewing it will be merged into the master branch.

The following workflows are recommended to participate in the contribution:

  1. Fork the repo to your own GitHub and clone it to your local development
  2. Create a new branch and develop on the new branch
  3. Keep the branch consistent with the remote develop branch (via fetch and rebase operations)
  4. Submit changes locally (please keep the commit log simple and standardized)
  5. Push the local submit to the repo of fork on GitHub
  6. Create a pull request to the develop branch of fluid-dev/hexo-theme-fluid

Contributors

contributors

Contributors outside the code：@zhugaoqi

License

MIT