hexo-theme-clarity 1.0.0

package/.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+    - "4.1"
+install:
+    npm install

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2025 guozhenyi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README-en.md

@@ -0,0 +1,319 @@
+# Clarity
+
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/guozhenyi/hexo-theme-clarity/blob/master/LICENSE)
+
+[Preview](https://www.guozhenyi.com)
+
+A clean Hexo theme template with great performance on different devices. 
+
+forked and modified from [maupassant](https://github.com/tufu9441/maupassant-hexo).
+
+## Installation
+Install theme and renderers:
+
+```shell
+$ git clone https://github.com/guozhenyi/hexo-theme-clarity.git themes/clarity
+$ npm install hexo-renderer-pug --save
+$ npm install hexo-renderer-sass-next --save
+```
+
+Then change your `theme` setting in `_config.yml` to `clarity`.
+
+## Configuration
+Default config:
+
+```YAML
+disqus:
+  enable: false ## If you want to use Disqus comment system, please set the value to true.
+  shortname: ## Your disqus_shortname, e.g. username
+  api: ## You can visit Disqus comments in China mainland without barriers using Disqus API, e.g. https://disqus.skk.moe/disqus/
+  apikey: ## Your API key obtained in Disqus API Application, e.g. yk00ZB1fjYGRkrCrDDRYDUjpp26GJWJiJRZQZ5SY0r3th5FMW6pnSzQMnWH7ua7r
+  admin: ## Username of your Disqus moderator, e.g. username
+  admin_label: ## The text of Disqus moderator badge, e.g. Mod
+uyan: ## Your uyan_id. e.g. 1234567
+livere: ## Your livere data-uid, e.g. MTAyMC8zMDAxOC78NTgz
+changyan: ## Your changyan appid, e.g. cyrALsXc8
+changyan_conf: ## Your changyan conf, e.g. prod_d8a508c2825ab57eeb43e7c69bba0e8b
+gitalk: ## See: https://github.com/gitalk/gitalk
+  enable: false ## If you want to use Gitment comment system please set the value to true.
+  owner: ## Your GitHub ID, e.g. username
+  repo: ## The repository to store your comments, make sure you're the repo's owner, e.g. gitalk.github.io
+  client_id: ## GitHub client ID, e.g. 75752dafe7907a897619
+  client_secret: ## GitHub client secret, e.g. ec2fb9054972c891289640354993b662f4cccc50
+  admin: ## Github repo owner and collaborators, only these guys can initialize github issues.
+valine: ## See: https://valine.js.org
+  enable: false ## If you want to use Valine comment system, please set the value to true.
+  appid: ## Your LeanCloud application App ID, e.g. pRBBL2JR4N7kLEGojrF0MsSs-gzGzoHsz
+  appkey: ## Your LeanCloud application App Key, e.g. tjczHpDfhjYDSYddzymYK1JJ
+  notify: false ## Mail notifier, see https://github.com/xCss/Valine/wiki/Valine-评论系统中的邮件提醒设置
+  verify: false ## Validation code.
+  placeholder: Just so so ## Comment box placeholders.
+  avatar: "mm" ## Gravatar type, see https://github.com/xCss/Valine/wiki/avatar-setting-for-valine
+  pageSize: 10 ## Number of comments per page.
+  guest_info: nick,mail,link ## Attributes of reviewers.
+minivaline: ## See: https://github.com/MiniValine/MiniValine
+  enable: false ## If you want to use MiniValine comment system, please set the value to true.
+  appId: ## Your LeanCloud application App ID, e.g. pRBBL2JR4N7kLEGojrF0MsSs-gzGzoHsz
+  appKey: ## Your LeanCloud application App Key, e.g. tjczHpDfhjYDSYddzymYK1JJ
+  placeholder: Write a Comment ## Comment box placeholder.
+  adminEmailMd5: ## The MD5 of Admin Email to show Admin Flag.
+  math: true ## Support MathJax.
+  md: true ## Support Markdown.
+  # MiniValine's display language depends on user's browser or system environment
+  # If you want everyone visiting your site to see a uniform language, you can set a force language value
+  # Available values: en  | zh-CN | (and many more)
+  # More i18n info: https://github.com/MiniValine/minivaline-i18n
+  lang:
+waline: ## See: https://waline.js.org/
+  enable: false ## If you want to use Waline comment system, please set the value to true.
+  serverURL: ## Your server url, e.g. https://your-domain.vercel.app
+  pageSize: 30 ## The desired number of comments shown in each page.
+  wordLimit: 500 ## Limit the number of words in comments, 0 means no limit.
+  requiredMeta: ['nick','mail'] ## Required user information, e.g. ['nick','mail','link']
+  count: 5 ## The number comments displayed in the recent_comments widget, default is 10.
+utterances: ## See: https://utteranc.es
+  enable: false ## If you want to use Utterances comment system, please set the value to true.
+  repo: ## The repository utterances will connect to, e.g. tufu9441/comments
+  identifier: title ## The mapping between blog posts and GitHub issues.
+  theme: github-light ## Choose an Utterances theme which matches your blog.
+twikoo: ## See: https://twikoo.js.org
+  enable: false ## If you want to use twikoo comment system, please set the value to true.
+  envId: ## Tencent CloudBase envId
+  region: ## Tencent CloudBase region, e.g. ap-shanghai
+  path: ## Article path, e.g. window.location.pathname
+
+google_search: true ## Use Google search, true/false.
+baidu_search: false ## Use Baidu search, true/false.
+swiftype: ## Your swiftype_key, e.g. m7b11ZrsT8Me7gzApciT
+self_search: false ## Use a jQuery-based local search engine, true/false.
+google_analytics: ## Your Google Analytics tracking id, e.g. UA-42425684-2
+baidu_analytics: ## Your Baidu Analytics tracking id, e.g. 8006843039519956000
+microsoft_clarity:  ## Your Microsoft Clarity tracking id, e.g. zg2ctuea9j
+fancybox: true ## If you want to use fancybox please set the value to true.
+show_category_count: false ## If you want to show the count of categories in the sidebar widget please set the value to true.
+toc_number: true ## If you want to add list number to toc please set the value to true.
+shareto: false ## If you want to use the share button please set the value to true, and you must have hexo-helper-qrcode installed.
+busuanzi: false ## If you want to use Busuanzi page views please set the value to true.
+wordcount: false ## If you want to display the word counter and the reading time expected to spend of each post please set the value to true, and you must have hexo-wordcount installed.
+widgets_on_small_screens: false ## Set to true to enable widgets on small screens.
+canvas_nest:
+  enable: false ## If you want to use dynamic background please set the value to true, you can also fill the following parameters to customize the dynamic effect, or just leave them blank to keep the default effect.
+  color: ## RGB value of the color, e.g. "100,99,98"
+  opacity: ## Transparency of lines, e.g. "0.7"
+  zIndex: ## The z-index property of the background, e.g. "-1"
+  count: ## Quantity of lines, e.g. "150"
+donate:
+  enable: false ## If you want to display the donate button after each post, please set the value to true and fill the following items on your need. You can also enable donate button in a page by adding a "donate: true" item to the front-matter.
+  github: ## GitHub URL, e.g. https://github.com/Kaiyuan/donate-page
+  alipay_qr: ## Path of Alipay QRcode image, e.g. /img/AliPayQR.png
+  wechat_qr: ## Path of Wechat QRcode image, e.g. /img/WeChatQR.png
+  btc_qr: ## Path of Bitcoin QRcode image, e.g. /img/BTCQR.png
+  btc_key: ## Bitcoin key, e.g. 1KuK5eK2BLsqpsFVXXSBG5wbSAwZVadt6L
+  paypal_url: ## Paypal URL, e.g. https://www.paypal.me/tufu9441
+post_copyright:
+  enable: false ## If you want to display the copyright info after each post, please set the value to true and fill the following items on your need.
+  author: ## Your author name, e.g. tufu9441
+  copyright_text: ## Your copyright text, e.g. The author owns the copyright, please indicate the source reproduced.
+love: false ## If you want the peach heart to appear when you click anywhere, set the value to true.
+plantuml: ## Using PlantUML to generate UML diagram, must install hexo-filter-plantuml (https://github.com/miao1007/hexo-filter-plantuml).
+  render: "PlantUMLServer" ##  Local or PlantUMLServer.
+  outputFormat: "svg" ## common options: svg/png
+copycode: true ## If you want to enable one-click copy of the code blocks, set the value to true.
+dark: false ## If you want to toggle between light/dark themes, set the value to true.
+totop: true ## If you want to use the rocketship button to return to the top, set the value to true.
+external_css: false ## If you want to load an external CSS file, set the value to true and create a file named "external.css" in the source/css folder.
+post_content_length: 180 ## Set the length of the post summary displayed on home page when no description written.
+
+menu:
+  - page: home
+    directory: .
+    icon: fa-home
+  - page: archive
+    directory: archives/
+    icon: fa-archive
+  - page: about
+    directory: about/
+    icon: fa-user
+  - page: rss
+    directory: atom.xml
+    icon: fa-rss
+
+widgets: ## Seven widgets in sidebar provided: search, info, category, tag, recent_posts, recent_comments and links.
+  - search
+  - info
+  - category
+  - tag
+  - recent_posts
+  - recent_comments
+  - links
+
+info:
+  avatar: /img/avatar.png
+  discription: To be a better man.
+  outlinkitem:
+    - name: twitter
+      outlink: https://twitter.com/username
+      message: Twitter
+    - name: envelope
+      outlink: mailto:admin@domain.com
+      message: Email
+    - name: github
+      outlink: https://github.com/username
+      message: Github
+    - name: rss
+      outlink: /atom.xml
+      message: RSS
+
+links:
+  - title: site-name1
+    url: http://www.example1.com/
+    src: https://www.example1.com/favicon.ico
+    desc: XXX's Blog
+  - title: site-name2
+    url: http://www.example2.com/
+    src: https://www.example1.com/favicon.ico
+    desc: YYY's Blog
+  - title: site-name3
+    url: http://www.example3.com/
+    src: https://www.example3.com/favicon.ico
+    desc: ZZZ's Blog
+
+timeline:
+  - num: 1
+    word: 2014/06/12-Start
+  - num: 2
+    word: 2014/11/29-XXX
+  - num: 3
+    word: 2015/02/18-DDD
+  - num: 4
+    word: More
+
+# Static files
+js: js
+css: css
+
+# Theme version
+version: 1.0.0
+```
+- disqus - [Disqus](https://disqus.com) comment system, integrated with [DisqusJS](https://github.com/SukkaW/DisqusJS) API.
+- uyan - [Uyan](http://www.uyan.cc) id
+- livere - [LiveRe](https://livere.com) data-uid
+- changyan - [Changyan](http://changyan.kuaizhan.com) appid
+- gitalk - [Gitalk](https://github.com/gitalk/gitalk) comment system
+- valine - [Valine](https://valine.js.org) comment system
+- minivaline - [MiniValine](https://github.com/MiniValine/MiniValine) comment system
+- waline - [Waline](https://waline.js.org) comment system
+- utterances - [Utterances](https://utteranc.es) comment system
+- twikoo - [Twikoo](https://twikoo.js.org) comment system
+- google_search - Default search engine
+- baidu_search - Search engine for users in China
+- swiftype - [Swiftype Search](https://swiftype.com) key
+- self_search - A jQuery-based [local search engine](https://www.hahack.com/codes/local-search-engine-for-hexo/), with the dependency on the plugin [hexo-generator-search](https://github.com/wzpan/hexo-generator-search)
+- google_analytics - [Google Analytics](https://www.google.com/analytics/) tracking id
+- baidu_analytics - [Baidu Analytics](https://tongji.baidu.com) tracking id
+- microsoft_clarity - [Microsoft Clarity](https://clarity.microsoft.com/) tracking id
+- fancybox - Enable [Fancybox](https://fancyapps.com/fancybox/)
+- show_category_count - Show the count of categories in the sidebar widget
+- toc_number - Show the list number of toc
+- shareto - Enable share button, with the dependency on the plugin [hexo-helper-qrcode](https://github.com/yscoder/hexo-helper-qrcode)
+- busuanzi - Enable [Busuanzi](http://ibruce.info) page views
+- wordcount - Enable [hexo-wordcount](https://github.com/willin/hexo-wordcount) of each post
+- widgets_on_small_screens - Show the widgets at the bottom of small screens
+- canvas_nest - Enable [canvas-nest.js](https://github.com/hustcc/canvas-nest.js/blob/master/README-zh.md) dynamic background
+- donate - Enable donate button after each post
+- post_copyright - Enable copyright info after each post
+- love - Enable peach heart when clicking anywhere
+- plantuml - Enable PlantUML to generate UML diagram
+- copycode - Enable one-click copy of code blocks
+- dark - Enable to toggle between light/dark modes of the theme
+- totop - Enable the rocketship to-top button
+- external_css - Enable loading an external CSS file
+- post_content_length - Abstract length of each post
+- menu - Customize your menu of pages here, just follow the format of existied items. Don't forget to create corresponding folders inlcuding `index.md` in `source` folder to ensure the pages will correctly display. [FontAwesome](https://fontawesome.com) icon fonts have been integrated, and you can choose other icons which you like [here](https://fontawesome.com/icons/) and use them according to the instruction.
+- widgets - Choose and arrange the widgets in sidebar here.
+- info - Set your personal information of the info widget here.
+- links - Edit your blogroll here, and an independent blogroll page can be displayed by setting `layout: blogroll` of a page.
+- timeline - Show a timeline of the website by setting `layout: timeline` of a page.
+- Static files - Static files directory, for convenience of CDN usage.
+- Theme version - For automatic refresh of static files on CDN.
+
+## Features
+#### Logo
+You can set a **favicon.ico** for your website, please put it into `source` folder of hexo directory, recommended size: 32px*32px.
+
+You can add a website logo for apple devices, please put an image named **apple-touch-icon.png** into `source` folder of hexo directory, recommended size: 114px*114px.
+
+#### Abstract
+You can control the abstract of a post shown at index, by either filling a `description:` item in `front-matter` of the `post.md`, or just inserting a `<!--more-->` before your hidden content.
+
+#### Page
+Create folders inlcuding `index.md` in `source` folder to add pages, and add a `layout: page` in `front-matter` of `index.md`. A tagcloud page can be enabled by setting `layout: tagcloud` of a page. If you need a single column page without sidebar, just set `layout: single-column` instead of `layout: page`.
+
+#### Table of Contents
+TOC in a post can be enabled by adding a `toc: true` item in `front-matter`.
+
+#### Comments
+Comment feature of each post and page can be enabled (default) and disabled by adding a `comments: true` or a `comments: false` in `front-matter`. This could be useful when you want comment feature for a guestbook page, but don't want comment feature for a about page.
+
+#### Syntax Highlighting
+Highlighted code showcase is supported, please set the `highlight` option in `_config.yml` of hexo directory like this:
+
+```YAML
+highlight:
+  enable: true
+  auto_detect: true
+  line_number: true
+  tab_replace:
+```
+
+#### Math Equation
+Add
+```YAML
+mathjax: true
+```
+in Hexo's `_config.yml`.
+
+In the post which you would like to use math equation, add `mathjax: true` in the `front-matter`. For example:
+
+```YAML
+title: Test Math
+date: 2016-04-05 14:16:00
+categories: math
+mathjax: true
+---
+```
+The default math delimiters are `$$...$$` and `\\[...\\]` for displayed mathematics,
+and `$...$` and `\\(...\\)` for in-line mathematics.
+
+However, if your post contains dollar signs (`$`), and they appear often in non-mathematical parts, in other words, you want to use `$` as dollar sign not inline math delimiter, please add
+
+```YAML
+mathjax2: true
+```
+in Hexo's `_config.yml` instead of `mathjax: true`. Correspondingly, add `mathjax2: true` to the `front-matter` of the post in which
+you would like to use math equation.
+
+#### Languages
+Seven languages are available for this theme currently: Simplified Chinese (zh-CN), Traditional Chinese (zh-TW), English (en), French (fr-FR), German (de-DE), Korean (ko) and Spanish (es-ES). Contributions of translating to other languages will be highly appreciated.
+
+## Solutions
+- Check whether your Terminal's current directory is in hexo's root directory which contains `source/`, `themes/`, etc.
+
+- If you have any trouble in using this theme, please feel free to open an [issue](https://github.com/guozhenyi/hexo-theme-clarity/issues).
+
+## Browsers Support
+| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)<br/>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)<br/>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)<br/>Opera |
+| --------- | --------- | --------- | --------- | --------- |
+| IE9+, Edge| last 10 versions| last 10 versions| last 7 versions| last 10 versions
+
+## Contributing
+All kinds of contributions (enhancements, new features, documentation & code improvements, issues & bugs reporting) are welcome.
+
+Looking forward to your [pull request](https://github.com/guozhenyi/hexo-theme-clarity/pulls).
+
+## Contributors
+Thanks for all contributors of this repo.
+
+<a href="https://github.com/guozhenyi/hexo-theme-clarity/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=guozhenyi/hexo-theme-clarity" />
+</a>