hexo-theme-flat
v1.7.0
Published
A Hexo theme aims to isolate your focus onto writing.
Downloads
1,194
Readme
Flat for Hexo
1.5.0 is the first version to be relatively available.
Flat for Hexo theme is a light and simple theme based on Material Design Lite. Its code is easy to read and easy to be modified.
The main purpose of developing this theme is for me to learn about front-end development and try out some new things.
- Use Material Design Lite as its layout framework.
- Use PNPM to manage its dependences.
Quick Start
It is recommended to install the theme via node,
npm install --save hexo-theme-flat
Or, you can install the theme manually,
git clone https://github.com/breeze256/hexo-theme-flat.git ./themes/flat
Once you install the theme, change the default theme in your _config.yml
.
# Extensions
## Plugins: https://hexo.io/plugins/
## Themes: https://hexo.io/themes/
theme: flat
Configuration
It is not recommended to directly modify any files in the flat theme. Because this may cause errors (e.g. merge conflicts), and the modified files may be discarded when upgrading the theme.
I strongly recommend users to use the Alternate Theme Config to configure the theme.
cp node_modules/hexo-theme-flat/_config.yml _config.flat.yml
# Now you can configure the theme.
vim _config.flat.yml
Necessary packages
This theme uses SASS to be used as a CSS preprocessor, so you may need a SASS renderer.
And an excerpt plugin is also recommended,
hexo-renderer-dartsass
hexo-excerpt
You may want to remove some renderers that you no longer need,
hexo-renderer-stylus
hexo-renderer-ejs
And I recommend using
hexo-renderer-markdown-it
instead of hexo-renderer-marked
.
Highlighting
Flat currently only supports prismjs highlighting.
You should change the default highlighter in your _config.yml
if you want highlighting.
syntax_highlighter: prismjs