{"id":13430705,"url":"https://github.com/zthxxx/hexo-theme-Wikitten","last_synced_at":"2025-03-16T06:30:58.611Z","repository":{"id":53600646,"uuid":"79658206","full_name":"zthxxx/hexo-theme-Wikitten","owner":"zthxxx","description":"A theme of Hexo for personal wiki which seems like Wikitten style.","archived":false,"fork":false,"pushed_at":"2022-09-25T03:32:57.000Z","size":1968,"stargazers_count":677,"open_issues_count":31,"forks_count":132,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-05-20T09:16:52.504Z","etag":null,"topics":["hexo","hexo-theme","hexo-wiki","personal-wiki","theme","wiki","wikitten"],"latest_commit_sha":null,"homepage":"https://wiki.zthxxx.me/","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/zthxxx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-21T16:41:25.000Z","updated_at":"2024-05-19T01:20:48.000Z","dependencies_parsed_at":"2023-01-18T21:45:55.434Z","dependency_job_id":null,"html_url":"https://github.com/zthxxx/hexo-theme-Wikitten","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zthxxx%2Fhexo-theme-Wikitten","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zthxxx%2Fhexo-theme-Wikitten/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zthxxx%2Fhexo-theme-Wikitten/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zthxxx%2Fhexo-theme-Wikitten/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zthxxx","download_url":"https://codeload.github.com/zthxxx/hexo-theme-Wikitten/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243835952,"owners_count":20355611,"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":["hexo","hexo-theme","hexo-wiki","personal-wiki","theme","wiki","wikitten"],"created_at":"2024-07-31T02:00:56.951Z","updated_at":"2025-03-16T06:30:58.171Z","avatar_url":"https://github.com/zthxxx.png","language":"JavaScript","funding_links":[],"categories":["Content","JavaScript"],"sub_categories":[],"readme":"# hexo-theme-Wikitten\n\n[中文版文档](./README_zh-CN.md)\n\n### A personal wiki imitate [Wikitten](https://wikitten.vizuina.com/) style for Hexo. \u003e[Preview](http://wiki.zthxxx.me/)\n\nsome features:\n\n- Applicable to personal wiki knowledge management\n- Simple, double column, classified management\n- The knowledge of multi-level sorting, the side can be expand at all levels of classification, easy to jump\n- Categorize article according to file directory  #4\n\n![Site Preview](./source/images/SitePreview.png)\n\n\n\n![mobile preview](./source/images/mobile1.png) ![mobile preview](./source/images/mobile2.png)\n\n\n\n## Installation\n\n`hexo-theme-Wikitten` kernel code base on [icarus](https://github.com/ppoffice/hexo-theme-icarus), so you can read base function document with [icarus wiki](https://github.com/ppoffice/hexo-theme-icarus/wiki).\n\n### Install\n\n**Note: This theme requires Hexo v3.6 or late.**\n\n1. Go to your hexo folder, then clone this theme `Wikitten` into `themes/`\n\n```bash\n$ cd your-hexo-directory\n$ git clone https://github.com/zthxxx/hexo-theme-Wikitten.git themes/Wikitten\n```\n\n2. Rewrite to cover some default page template in site folder\n\n```bash\n$ cp -rf themes/Wikitten/_source/* source/\n$ cp -rf themes/Wikitten/_scaffolds/* scaffolds/\n```\n\n3. Rename the `_config.yml.example` to `_config.yml` so you can config theme\n\n```bash\n$ cp -f themes/Wikitten/_config.yml.example themes/Wikitten/_config.yml\n# edit and customize it\n$ vim themes/Wikitten/_config.yml\n```\n\nmost configurations are same as the [icarus](https://github.com/ppoffice/hexo-theme-icarus) theme, you can read with [icarus wiki](https://github.com/ppoffice/hexo-theme-icarus/wiki) at first.\n\nsome recommend options setting which you can out of the box, see below [#Configuration](#Configuration).\n\n4. Plugins requires in theme [`package.json`](./package.json) and you need install these.\n\nhere is those function and effect:\n\n```json\nhexo-autonofollow       // automatic make user open external links in new tab\nhexo-directory-category // automatic categorize article according to their file directory\nhexo-generator-feed     // generate Atom 1.0 or RSS 2.0 feed\nhexo-generator-json-content // generate a json content file for site search\nhexo-generator-sitemap  // generate sitemap\n```\n\nyou can merge these plugins into the **site's** `package.json` file by `npm install ` command install them once,\n\nor in the **site folder**, you can install them with the following command:\n\n```bash\n$ npm install --save hexo-autonofollow hexo-directory-category hexo-generator-feed hexo-generator-json-content hexo-generator-sitemap\n```\n\n5. `mathjax` renderer configuration (optional)：\n\nIf you need to write mathematical formulas, the following configuration is recommended:\n\nFirst, you need to install [pandoc](https://pandoc.org/installing.html)，and modify the rendering engine under the hexo site in the meanwhile:\n\n```bash\n$ npm un hexo-renderer-marked --save\n$ npm i hexo-rendere-pandoc --save # or hexo-renderer-krammed\n```\n\nModify settings in site config file `_config.yml`:\n\n```bash\nmath:\n  enable: true\n  engine: mathjax\n```\n\n### Enable\n\nModify `theme` setting in site config file `_config.yml` to **`Wikitten`**.\n\n### Update\n\n```bash\n$ cd themes/Wikitten\n$ git pull origin master\n```\n\n## Configuration\n\nIn site config file `_config.yml`, **recommend settings**:\n\n```yaml\n# Hexo Configuration\n# URL\npermalink: wiki/:title/\n\n# Directory\nskip_render:\n  - README.md\n  - '_posts/**/embed_page/**'\n\n# Writing\nnew_post_name: :title.md # File name of new posts\n\n## Markdown\n## https://github.com/hexojs/hexo-renderer-marked\nmarked:\n  gfm: true\n  \n## Plugins: https://hexo.io/plugins/\n### JsonContent\njsonContent:\n  meta: false\n  pages:\n    title: true\n    date: true\n    path: true\n    text: true\n  posts:\n    title: true\n    date: true\n    path: true\n    text: true\n    tags: true\n    categories: true\n  ignore:\n    - 404.html\n    \n### Creat sitemap\nsitemap:\n  path: sitemap.xml\n\n### Adds nofollow attribute to all external links in your hexo blog posts automatically.\nnofollow:\n  enable: true\n  exclude:\n    - \u003cyour site url domain\u003e # eg: zthxxx.me\n```\n\nIn **theme** config file `Wikitten/_config.yml`, you can read more detailed commentary for some options.\n\n**Before the start, plase first change my personal info to yourself, including options that `profile` `social_links` `history_control` and so on.**\n\n### `profile`, `comment`, `Share` and `miscellaneous` are **DEFAULT DISABLE**! \n\n(You still can enable them, but not recommend.)\n\nother theme **recommend settings**:\n\n```yaml\n# Customize\ncustomize: # modify this information for yourself\n    sidebar: left # sidebar position, options: left, right\n    category_perExpand: false # enable article categories list per expanding\n    default_index_file: index.md # enable this, it will display at site index instead of default index page, or disable that it will display more articles order by time \n    \n# Widgets\nwidgets: # default use category only\n    - category\n    # - recent_posts\n    # - archive\n    # - tag\n    # - tagcloud\n    # - links\n    \n# History version \nhistory_control: # make you wiki has history version control in page (view source code, edit online, compare historical changes)\n    enable: true\n    server_link: https://github.com # recommend use GitHub - https://github.com\n    user: \u003cyour GitHub name\u003e\n    repertory: \u003cyour repertory name of this wiki source code\u003e\n    branch: \u003cbranch name of this wiki site source code\u003e\n```\n\n\n\n## License\n\n[MIT LICENSE](./LICENSE)\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzthxxx%2Fhexo-theme-Wikitten","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzthxxx%2Fhexo-theme-Wikitten","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzthxxx%2Fhexo-theme-Wikitten/lists"}