👉 English README | 简体中文说明
It is based on the original LoveIt Theme, KeepIt Theme and LeaveIt Theme.
The FixIt theme inherits the excellent features of these themes, and adds new features and optimizations on those basis. Please read Why Choose FixIt to learn more.
Head to this documentation page for a complete guidence to get started with the FixIt theme.
Or run Documentation Site locally:
git clone --recursive https://github.com/hugo-fixit/FixIt.git && cd FixIt
hugo server --source=docs
In addition, there is the FixIt wiki.
If you are currently using the LoveIt theme (or some other themes), it is very easy to migrate to FixIt.
You can add this repo as a submodule of your site directory.
# Stable version
git submodule add https://github.com/hugo-fixit/FixIt.git themes/FixIt
# ⚠️ Dev version
git submodule add -b dev https://github.com/hugo-fixit/FixIt.git themes/FixIt
Next, go to the config.toml
and change the default theme to FixIt
.
- theme = "LoveIt"
+ theme = "FixIt"
Now the migration is finished and everything is ready 🎉
And later you can update the submodule in your site directory to the latest commit using this command:
git submodule update --remote --merge
The FixIt theme inherits the excellent features of themes such as LoveIt, and adds new features and optimizations on those basis, as detailed in Features. In addition, the FixIt theme has the following advantages:
- Complete Chinese and English official documentations
- Community support: Theme official website, Discussions and official QQ group
- Continuously and actively update
- Constantly incorporate suggestions and ideas from all sides
- Highly open theme customizable section
In short, if you prefer the design language and freedom of the FixIt theme, and if you like to personalize your own themes as I do, the FixIt theme may be more suitable for you.
To see this theme in action, here are some live demo sites which are rendered with FixIt theme.
You could add your FixIt site to the list in nickname lexicographical order via making a PR. (e.g. #111)
- Optimized for performance: 99/100 on mobile and 100/100 on desktop in Google PageSpeed Insights
- Optimized SEO performance with a correct SEO SCHEMA based on JSON-LD
- Google Analytics supported
- Fathom Analytics supported
- Search engine verification supported (Google, Bing, Yandex, Pinterest, Baidu, 360 and Sogou)
- CDN for third-party libraries supported
- Automatically converted images with Lazy Load by lazysizes
- Responsive layout
- Light/Dark mode
- Globally consistent design language
- Pagination supported
- Easy-to-use and self-expanding table of contents
- Multilanguage supported and i18n ready
- Beautiful CSS animation
- Gravatar supported by Gravatar
- Local Avatar supported
- Up to 85 social links supported
- Up to 28 share sites supported
- Disqus comment system supported by Disqus
- Gitalk comment system supported by Gitalk
- Valine comment system supported by Valine
- Waline comment system supported by Waline
- Facebook comments system supported by Facebook
- Telegram comments system supported by Telegram Comments
- Commento comment system supported by Commento
- Utterances comment system supported by Utterances
- Artalk comment system supported by Artalk
- Twikoo comment system supported by Twikoo
- giscus comment system supported by giscus
- PWA (Progressive Web App) supported
- Sub Menu supported
- Content Encryption supported (Pages, Partial)
- Friends page embedded template
- Search supported by Lunr.js or algolia or Fuse.js
- Twemoji supported
- Automatically highlighting code
- Copy code to clipboard with one click
- Images gallery supported by lightgallery
- Extended Markdown syntax for Font Awesome icons
- Extended Markdown syntax for ruby annotation
- Extended Markdown syntax for fraction
- Mathematical formula supported by KaTeX
- Diagrams shortcode supported by mermaid
- Interactive data visualization shortcode supported by ECharts
- Mapbox shortcode supported by Mapbox GL JS
- Music player shortcode supported by APlayer and MetingJS
- Bilibili player shortcode
- Kinds of admonitions shortcode
- Custom style shortcode
- Custom script shortcode
- Animated typing supported by TypeIt
- Cookie consent banner supported by cookieconsent
- Web Watermark supported by cell-watermark
- Chinese typesetting supported by pangu.js
- ...
FixIt supports the following languages:
- English
- Simplified Chinese
- Traditional Chinese
- French
- Polish
- Brazilian Portuguese
- Italian
- Spanish
- German
- Serbian
- Russian
- Romanian
- Vietnamese
- Contribute with a new language
All feedback is welcome! Head over to the issues or discussions tracker.
Please see CONTRIBUTING.md for getting started with the contribution.
Make sure that you follow CODE_OF_CONDUCT.md while contributing and engaging in the discussions.
When contributing, please first discuss the change you wish to make via an issue on this repository before making the actual change.
Thanks to the authors of following resources included in the theme:
- normalize.css
- Font Awesome
- Simple Icons
- Animate.css
- autocomplete-js
- Lunr.js
- algoliasearch
- Fuse.js
- lazysizes
- object-fit-images
- Twemoji
- emoji-data
- lightgallery
- Sharer.js
- TypeIt
- KaTeX
- mermaid
- ECharts
- Mapbox GL JS
- APlayer
- MetingJS
- Gitalk
- Valine
- cookieconsent
- cell-watermark
- 不蒜子
- pangu.js
- Artalk
- Waline
- Twikoo
- github-corners
- giscus
- crypto-js
- vConsole
- eruda
- pace
The FixIt also draws on some features of the following projects, and thanks to their authors as well:
FixIt is licensed under the MIT license. Check the LICENSE file for details.
If you enjoy the theme, please consider buying me a coffee ☕️.
Thanks! ❤️