{"id":13430790,"url":"https://github.com/bennyxguo/hexo-theme-obsidian","last_synced_at":"2025-04-12T20:46:01.864Z","repository":{"id":40673473,"uuid":"210983823","full_name":"bennyxguo/hexo-theme-obsidian","owner":"bennyxguo","description":"🎨 A dark Hexo theme, it's responsive, simple but elegant.","archived":false,"fork":false,"pushed_at":"2023-08-17T05:26:37.000Z","size":113723,"stargazers_count":784,"open_issues_count":77,"forks_count":110,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-04T00:09:40.527Z","etag":null,"topics":["dark-hexo-theme","dark-mode","dark-theme","hexo","hexo-blog","hexo-theme","nightmode","obsidian","responsive-theme"],"latest_commit_sha":null,"homepage":"https://obsidian.tridiamond.tech/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bennyxguo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://www.buymeacoffee.com/tridiamond"]}},"created_at":"2019-09-26T02:38:50.000Z","updated_at":"2025-04-03T15:46:00.000Z","dependencies_parsed_at":"2024-01-18T14:41:20.711Z","dependency_job_id":"34e3e13a-ee78-409f-85b1-307b8b19b3d7","html_url":"https://github.com/bennyxguo/hexo-theme-obsidian","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bennyxguo%2Fhexo-theme-obsidian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bennyxguo%2Fhexo-theme-obsidian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bennyxguo%2Fhexo-theme-obsidian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bennyxguo%2Fhexo-theme-obsidian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bennyxguo","download_url":"https://codeload.github.com/bennyxguo/hexo-theme-obsidian/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248631696,"owners_count":21136559,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dark-hexo-theme","dark-mode","dark-theme","hexo","hexo-blog","hexo-theme","nightmode","obsidian","responsive-theme"],"created_at":"2024-07-31T02:00:57.831Z","updated_at":"2025-04-12T20:46:01.838Z","avatar_url":"https://github.com/bennyxguo.png","language":"JavaScript","funding_links":["https://www.buymeacoffee.com/tridiamond"],"categories":["Content","JavaScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003ca href=\"https://tridiamond.tech\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg width=\"100\" src=\"https://img-blog.csdnimg.cn/20200930013332450.png\" alt=\"TriDiamond logo\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eHexo Theme: Obsidian\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n\nv1.x | ᴅᴇsɪɢɴᴇᴅ \u0026 ᴄᴏᴅᴇᴅ ʙʏ ᴛʀɪᴅɪᴀᴍᴏɴᴅ \u003cbr\u003e\nA dark Hexo theme, it's responsive, simple but elegant.\n\n  \u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/v/release/TriDiamond/hexo-theme-obsidian\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/release-date/TriDiamond/hexo-theme-obsidian\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/TriDiamond/hexo-theme-obsidian\"\u003e\n    \u003ca href=\"https://gitter.im/TriDiamond/hexo-theme-obsidian?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge\"\u003e\u003cimg src=\"https://badges.gitter.im/TriDiamond/hexo-theme-obsidian.svg\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\n**[PREVIEW](https://obsidian.tridiamond.tech/)**\n| **[CHANGES](https://github.com/TriDiamond/hexo-theme-obsidian/blob/master/CHANGELOG.md)**\n\n🇨🇳 **[中文文档](https://github.com/TriDiamond/hexo-theme-obsidian/blob/master/README_CN.md)** |\n**[更变日志](https://github.com/TriDiamond/hexo-theme-obsidian/blob/master/CHANGELOG_CN.md)**\n\n\u003c/div\u003e\n\n\u003e I am working on a brand new theme called [`Aurora`](https://github.com/auroral-ui/hexo-theme-aurora), therefore this\n\u003e theme currently is not actively maintained. If you are from my blog website, the theme displayed there is the new\n\u003e theme.\n\n\u003cdetails\u003e\n  \u003csummary\u003eView new theme screenshots\u003c/summary\u003e\n\n![](https://img-blog.csdnimg.cn/202103280030531.png)\n\n![](https://img-blog.csdnimg.cn/20210328003140590.png)\n\n\u003c/details\u003e\n\n![screenshot](https://res.cloudinary.com/tridiamond/image/upload/v1573323147/blog/A-Obsidian-full_ubmo0d.png)\n\n\u003cdetails\u003e\n\u003csummary\u003eMore screen shots\u003c/summary\u003e\n\n## Categories Page\n\n![screenshot](https://res.cloudinary.com/tridiamond/image/upload/v1573148012/blog/A-Obsidian-categories_mgdti7.png)\n\n## Categories Leveled\n\n![screenshot](https://res.cloudinary.com/tridiamond/image/upload/v1573148016/blog/A-Obsidian-categories-level_xtxty9.png)\n\n## Archives\n\n![screenshot](https://res.cloudinary.com/tridiamond/image/upload/v1573323148/blog/A-Obsidian-archives_ffpwf9.png)\n\n## Articles\n\n![screenshot](https://res.cloudinary.com/tridiamond/image/upload/v1573148016/blog/A-Obsidian-articles_wlsu2v.png)\n\n\u003c/details\u003e\n\n## Install\n\n```bash\ngit clone https://github.com/TriDiamond/hexo-theme-obsidian.git obsidian\n```\n\n## Usage\n\n### Activate Theme\n\nOpen `Hexo` config file `_config.yml`, set theme to `obsidian`\n\n```yaml\n---\ntheme: obsidian\n```\n\n### Installing required packages\n\nFirst open your terminal, and `cd` in the theme folder `obsidian`.\n\n```shell\ncd themes/obsidian\n```\n\nThen run `npm` to install all required packages for the theme.\n\n```shell\nnpm install\n```\n\n### Theme settings\n\nOpen `/themes/obsidian/_config.yml` can change the theme configs\n\n\u003cdetails\u003e\n\u003csummary\u003eFull detail config\u003c/summary\u003e\n\n```yaml\n#! ---------------------------------------------------------------\n#!  ▄▀▄ █▀▄ ▄▀▀ ▀ █▀▄ ▀ ▄▀▄ █▄░█\n#!  █░█ █▀█ ░▀▄ █ █░█ █ █▀█ █░▀█\n#!  ░▀░ ▀▀░ ▀▀░ ▀ ▀▀░ ▀ ▀░▀ ▀░░▀\n#! ᴅᴇsɪɢɴᴇᴅ \u0026 ᴄᴏᴅᴇᴅ ʙʏ ᴛʀɪᴅɪᴀᴍᴏɴᴅ\n#! ---------------------------------------------------------------\n#! Theme Obsidian - A dark Hexo theme, it's responsive, simple but elegant.\n#! Thanks to and inspirated by CSS-Tricks\n#! @author: TriDiamond\n#! @github: https://github.com/TriDiamond\n#! @changelogs: https://github.com/TriDiamond/hexo-theme-obsidian/blob/master/CHANGELOG.md\n#! @feedbacks: https://github.com/TriDiamond/hexo-theme-obsidian/issues/new\n#! ---------------------------------------------------------------\n\n#! ---------------------------------------------------------------\n#!  █▄░█ ▄▀▄ ▀█▀ █▀▀ ▄▀▀\n#!  █░▀█ █░█ ░█░ █▀▀ ░▀▄\n#!  ▀░░▀ ░▀░ ░▀░ ▀▀▀ ▀▀░ v1.x\n#! ---------------------------------------------------------------\n#! Since version `v1.3.5` code block highlight has changed from `highlight.js` to\n#! `codemirror`, but the Hexo default highlight still need to be disabled to take affect.\n#! !! So Please make sure you disabled Hexo's default highlight setting !!\n#! ---------------------------------------------------------------\n#! Rebuild files after you changed the config:\n#! `hexo clean \u0026\u0026 hexo g`\n#! ---------------------------------------------------------------\n#! highlight:\n#!  enable: false\n#!  line_number: true\n#!  auto_detect: true\n#!  tab_replace:\n#! ---------------------------------------------------------------\n\n# Theme version\n# !! DO NOT EDIT THIS !!\nversion: '1.4.9.4'\n\n# ---------------------------------------------------------------\n# Theme default settings\n# ---------------------------------------------------------------\n\n# Menu setting | format = title_name: link_url\nmenu:\n    PAGE: /page\n\n# Page custom titles\npage_titles:\n    categories: 'Categories'\n    tags: 'Tags'\n    archives: 'Archived'\n\n# Social media links\nsocials:\n    github: \"\"\n    twitter: \"\"\n    stackoverflow: \"\"\n\n# Enable table of content\nTOC: true\n\n# Home page first post default cover image, default use cover\nwelcome_cover: /img/cover.jpg\n\n# Article default cover image\ncover: /img/welcome-cover.jpg\n\n# Avatar\navatar: https://s2.ax1x.com/2019/09/19/nLtSiD.png\n\n# Disable default scrollbar\nscrollbar: true\n\n# Website keywords used for SEO\nkeywords: TriDiamond Obsidian\n\n# Website slogans\ndescriptionOne: 'Think like an artist, develop like an artisan'\ndescriptionTwo: '艺术家思维去思考问题，工匠创造精神去开发'\n\n# If you use google analytics, please fill in the ID\ngoogle_analytics:\n\n# Website favicon\nfavicon: /img/favicon.png\n\n# rss file\nrss: atom.xml\n\n# ---------------------------------------------------------------\n# Article Music settings\n# ---------------------------------------------------------------\n\n# Auto play article audio\nautoplay: false\n\n# default mp3 file\nmp3:\n    - statics/chengdu.mp3\n\n# ---------------------------------------------------------------\n# Plugins\n# ---------------------------------------------------------------\n\n# Gitalk comment plugin\n# see https://github.com/gitalk/gitalk\ngitalk:\n    enable: true\n    autoExpand: false\n    clientID: ''\n    clientSecret: ''\n    repo: ''\n    owner: ''\n    admin: [ '' ]\n    # Ensure uniqueness and length less than 50\n    id: location.pathname\n    # Facebook-like distraction\n    proxy: https://cors-anywhere.azm.workers.dev/https://github.com/login/oauth/access_token\n    # Custom proxy server\n\n# Valine comment plugin (recommended!)\n# see https://valine.js.org/quickstart.html\nvaline:\n    enable: false\n    app_id:\n    app_key:\n    notify: false\n    verify: false\n    avatar: 'mp'\n    placeholder: 'Leave your throughs behind~'\n    visitor: true\n\n# Enable symbols-count-time plugin\n# see https://github.com/theme-next/hexo-symbols-count-time\nsymbols_count_time:\n    enable: true\n    wordCount: true\n    readCount: true\n    awl: 4\n    wpm: 275\n    suffix: mins.\n\n# Enable html truncate\n# see https://github.com/TriDiamond/hexo-html-truncate\nhtml_truncate:\n    enable: true\n    # Characters kept for posts\n    postLength: 250\n    # Characters kept for cover posts\n    coverLength: 100\n    ellipsis: '...'\n    # Excluding html tags\n    excludes: [ 'img' ]\n    # Characters count including white spaces\n    keepWhitespaces: true\n    # Reserving the last complete word, without breaking the word\n    reserveLastWord: true\n\n# Enable Busuanzi statistic plugin\n# see http://ibruce.info/2015/04/04/busuanzi/\nbusuanzi:\n    enable: true\n\n# Enable social media sharing\n# see https://github.com/overtrue/share.js/\nsharejs:\n    enable: true\n    disabled: 'facebook,douban,linkedin,diandian,tencent,google'\n\n# Use codemirror instead of highlight js for better colors\n# if you want more language support check the modes list at official website\n# modes see: https://codemirror.net/mode/\n# see https://codemirror.net/\ncodemirror:\n    modes: [ 'javascript', 'css', 'xml', 'htmlmixed', 'clike', 'php', 'shell', 'python' ]\n\n# Enabling mathjax support\nmathjax: true\n\n# This function is only used for those that server is located in China. If your server is located in outside China, you do not need to add the following code.\n#beianloc:\nbeian:\n    # Enable\n    enable: true\n    # Beian location，for example：粤ICP备\n    beianloc:\n    # Beian ID，for example：2021022134号。\n    beianid:\n\n# Police Beian\npolice:\n    # Enable\n    enable: true\n    # Beian location，for example: 粤公网安备\n    beianloc:\n    # Beian ID, for example: 44010602009049号\n    beianid:\n    # Beian Icon, for example: /img/beian.png\n    beianicon:\n\n# Custom mouse style\nmouse:\n    # Enable custom mouse style\n    enable: true\n    # Default style\n    default: /default.png\n    # Hover sytle\n    pointer: /hover.png\n\n# APlayer, now only support netease music list\naplayer:\n    # Enable aplayer\n    enable: true\n    # Music list ID\n    musiclist: \"\"\n\n# Live2D\nl2d:\n    # Enable live2d\n    enable: true\n```\n\n\u003c/details\u003e\n\n### Comments\n\nYou can choose from using Valine or Gitalk\n\n- If you are using `Valine`, you need to turn off `busuanzi`,because Valine has article view count support.\n- If you are using `Gitalk`, you may turn on `busuanzi`, to have article view count enable.\n\n### Code block style\n\n\u003e Since version `v1.3.5` code block highlight has changed from `highlight.js` to\n\u003e `codemirror`, Hexo default highlight need to be disabled to take affect.\n\u003e !! So Please make sure you disabled Hexo's default highlight setting !!\n\nHexo configuration file `_config.yml` located at the ROOT path of your blog.\n\n\u003e ⚠️ Please note do not make these changes in the theme's config file,\n\u003e changing configs in the theme config file `_config.yml`\n\u003e will not work properly.\n\n```yaml\n---\nhighlight:\n    enable: false\n    line_number: true\n    auto_detect: true\n    tab_replace:\n```\n\nCodemirror settings\n\n```yaml\n# Use codemirror instead of highlight js for better color syntax\n# if you want more language support check the modes list at official website\n# modes see: https://codemirror.net/mode/\n# see https://codemirror.net/\ncodemirror:\n    modes: [ 'javascript', 'css', 'xml', 'htmlmixed', 'clike', 'php', 'shell', 'python' ]\n```\n\nRebuild files after you changed the config\n\n```bash\nhexo clean \u0026\u0026 hexo g\n```\n\n### Preview character length\n\nThis post parameter changes how many characters are kept for the preview at home page.\n\n```yaml\ntitle: # My awesome title\ndate: # 2019-07-14 18:38:45\ncategories:\n#     - Category1 - Category2\ntags:\n#     - Tag1 - Tag2\nmp3: # http://domain.com/awesome.mp3\ncover: # http://domain.com/awesome.jpg\npreview: # 300\n```\n\n### Post template\n\nPost template settings\n\n```yaml\ntitle: # My awesome title\ndate: # 2019-07-14 18:38:45\ncategories:\n#   - Category1 - Category2\ntags:\n#   - Tag1 - Tag2\nmp3: # http://domain.com/awesome.mp3\ncover: # http://domain.com/awesome.jpg\n\nauthor: # 3rdparty author\navatar: # /example.jpg\nslogan: # example\nabstract: # short abstract\nabstracts: # long abstract\nsocials:\n    page:\n        link:\n        # social platform link\n        name:\n        # the iconfont you want to use, for example: icon-bilibili-fill\n        path:\n        # the css file of your iconfont, for example: /css/font_bilibili/iconfont.css\n    page2:\n        link:\n        name:\n        path:\n    page3:\n        link:\n        name:\n        path: \n```\n\n### Create categories page\n\nRun Hexo command to generate categories page\n\n```bash\nhexo new page categories\n```\n\nCategories template\n\n```yaml\ntitle: categories\ndate: 2019-07-14 12:39:04\ntype: 'categories'\n```\n\n\u003e Theme will auto generate categories contents.\n\n### Create tags page\n\nRun Hexo command to generate tags page\n\n```bash\nhexo new page tags\n```\n\nTags page template\n\n```yaml\ntitle: tags\ndate: 2014-12-22 12:39:04\ntype: \"tags\"\n```\n\n\u003e Theme will auto generate tags contents.\n\n### MathJax Support\n\nDefault enables mathjax support, can change it to `false` to turn it off.\n\n```yaml\n# Enabling mathjax support\nmathjax: true\n```\n\n## Update Theme\n\n\u003e Please backup your `_config.yml` file before update\n\n```bash\ncd themes/osidian\ngit pull\n```\n\n## Using the search engine\n\n### Installation guide\n\nInstall by npm\n\n```bash\n$ npm install hexo-generator-search --save\n```\n\nAdding the plugin config in your root `_config.yml`\n\n```yaml\nsearch:\n    path: search.xml\n    field: post\n    content: true\n```\n\nRegenerate files\n\n```bash\nhexo clean \u0026\u0026 hexo g\n```\n\n## Related\n\nI have made a [`Typro`](https://typora.io/) theme [`Obsidian`](https://github.com/TriDiamond/typro-theme-obsidian)\nespecially for this blog theme.\n\n## Feedback\n\n\u003e Please check the [ISSUES](https://github.com/TriDiamond/hexo-theme-obsidian/issues) before try to use the following\n\u003e contact methods!\n\u003e Maybe the question you have had being asked by others or it's already being answered. Thanks!\n\nYou can give me feedback or issue you have through the following methods:\n\n- [Create a issue!](https://github.com/TriDiamond/hexo-theme-obsidian/issues/new)\n- Joint QQGroup `909955326`\n- [Join Telegram Group](https://t.me/joinchat/R2m4eho2lbcHLR7nDvxd6A)\n\n## Donation\n\nAre you **enjoying this project** ? 👋\n\nYou can express your ❤️ by _buying me a coffee_ ☕️ to keep this project **maintained and stay alive**, I would ❤️ to **\ndedicate more time and effort** on it!\n\nIf there are enough coffee ☕️ I would like to become a **full time open source developer**! Keep producing more _awesome\nthemes and applications to the world_!\n\nHowever you could just **sharing this project with your friends**, that would _help me a lot as well_! 👊\n\nThanks for your love in advance! ☀️\n\n|                                                                                                                Donating using Paypal                                                                                                                 |\n| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |\n| \u003ca href=\"https://www.buymeacoffee.com/tridiamond\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" height=\"60\" width=\"217\" style=\"height: 60px !important;width: 217px !important;\" \u003e\u003c/a\u003e |\n\n\u003e All donator will be enlisted as Coffee Supporter and displayed in the Sponsor list in this section.\n\n---\n\n|                                         Wechat 微信支付                                         |                                        Alipay 支付宝支付                                        |\n| :---------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------: |\n| \u003cimg src=\"https://img-blog.csdnimg.cn/20210330175112304.png\" alt=\"Buy Me A Coffee\" width=\"150\"\u003e | \u003cimg src=\"https://img-blog.csdnimg.cn/20210330175153827.png\" alt=\"Buy Me A Coffee\" width=\"150\"\u003e |\n\n\u003e 所有赞助人将被列为咖啡支持者，并在本节的赞助人名单中显示。\n\n## Join the Community\n\n\u003ca href=\"https://discord.gg/VC7CrYfds5\" target=\"_blank\"\u003e\u003cimg src=\"https://discordapp.com/api/guilds/801943105913225246/widget.png?style=banner3\" alt=\"ObsidiaNext Community Discord Server\"\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbennyxguo%2Fhexo-theme-obsidian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbennyxguo%2Fhexo-theme-obsidian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbennyxguo%2Fhexo-theme-obsidian/lists"}