{"id":41187199,"url":"https://github.com/godofredoninja/kusi-doc","last_synced_at":"2026-01-22T20:18:33.849Z","repository":{"id":88670731,"uuid":"247315678","full_name":"godofredoninja/kusi-doc","owner":"godofredoninja","description":":smile: Beautiful and elegant theme for the documentation","archived":false,"fork":false,"pushed_at":"2020-05-30T04:27:41.000Z","size":1689,"stargazers_count":22,"open_issues_count":0,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-02-29T18:33:50.935Z","etag":null,"topics":["blog","documentation","ghost-blog-theme","ghost-cms","ghost-theme","theme","theme-development"],"latest_commit_sha":null,"homepage":"https://godofredo.ninja","language":"HTML","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/godofredoninja.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,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-03-14T16:48:16.000Z","updated_at":"2023-09-06T15:16:00.000Z","dependencies_parsed_at":"2024-02-14T05:44:01.872Z","dependency_job_id":null,"html_url":"https://github.com/godofredoninja/kusi-doc","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/godofredoninja/kusi-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godofredoninja%2Fkusi-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godofredoninja%2Fkusi-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godofredoninja%2Fkusi-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godofredoninja%2Fkusi-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/godofredoninja","download_url":"https://codeload.github.com/godofredoninja/kusi-doc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godofredoninja%2Fkusi-doc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28670366,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T19:36:09.361Z","status":"ssl_error","status_checked_at":"2026-01-22T19:36:05.567Z","response_time":144,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["blog","documentation","ghost-blog-theme","ghost-cms","ghost-theme","theme","theme-development"],"created_at":"2026-01-22T20:18:33.769Z","updated_at":"2026-01-22T20:18:33.834Z","avatar_url":"https://github.com/godofredoninja.png","language":"HTML","funding_links":["https://www.paypal.me/godofredoninja","https://www.buymeacoffee.com/GodoFredoNinja","https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=Y7UB5Q8GVN3HN\u0026source=url"],"categories":[],"sub_categories":[],"readme":"# Kusi Doc free theme for [Ghost](https://github.com/tryghost/ghost/)\n\n[![Ghost version](https://img.shields.io/badge/Ghost-3.x-brightgreen.svg)](https://github.com/TryGhost/Ghost)\n[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg)](https://www.paypal.me/godofredoninja)\n[![Buy Me A Coffee](https://img.shields.io/badge/-Buy%20Me%20A%20Coffee-%23FF813F)](https://www.buymeacoffee.com/GodoFredoNinja)\n\n\u003e *Kusi Doc is a beautiful and elegant theme for the documentation of your project.*\n\nHello :smile: , I created this theme for the documentation of your project.\nIt is available for free so you can use on your site. If you have any suggestions to improve the theme send me a tweet [@GodoFredoNinja](https://goo.gl/y3aivK)\n\n## If you have a :heart: and value my work. :pray: Please, help me with a small donation on [Paypal](https://www.paypal.me/godofredoninja) or [Here](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=Y7UB5Q8GVN3HN\u0026source=url). It'll help motivate me to update the theme with many improvements\n\n[![donate](./donate.gif)](https://www.paypal.me/godofredoninja)\n\n:arrow_right: If you still don't have a **Hosting for your Ghost**. Use [Digital Ocean](https://m.do.co/c/710a27a3b3de) using my [referral link]((https://m.do.co/c/710a27a3b3de)) and you will get free a **$100 in credit over 60 days** to use in [Digital Ocean]((https://m.do.co/c/710a27a3b3de)). This way you will also be helping me.\n\n[![Kusi Doc free theme for ghost](./screenshot.jpg)](https://godofredo.ninja)\n\n[![Kusi Doc](./documentation/doc-blog.jpg)](https://raw.githubusercontent.com/godofredoninja/kusi-doc/master/documentation/doc-blog.jpg)\n\n## Featured\n\n- Support for different [languages](http://themes.ghost.org/docs/i18n#section-how-to-add-any-language) (en - es)\n- Previous and next Post\n- Table of Content for documentation post\n- YouTube, Vimeo, kickstarter, dailymotion =\u003e Responsive\n- Code syntax [Prismjs](http://prismjs.com/index.html#languages-list) Supported all syntax\n\n## Table of Contents\n\n- [Web Browser Support for Kusi Doc](#web-browser-support-for-kusi-doc)\n- [Ghost Settings](#ghost-settings)\n- [Home Page](#home-page)\n- [Documentation Page](#documentation-page)\n- [Blog Page](#blog-page)\n- [Theme Translation](#theme-translation)\n- [PrismJS code syntax](#prismjs-code-syntax)\n\n## Web Browser Support for Kusi Doc\n\nKusi Doc supports the following web [browsers](http://caniuse.com/#search=flexbox).\n\n## Ghost Settings\n\nEnable the following checkbox on the Labs page in the Ghost admin panel.\n\n![ghost labs](./documentation/ghost-settings.jpg)\n\n## Home Page\n\n- Create a new page\n- Choose your favorite title\n- Use the url `kusi-doc-home` or your favorite url\n- First back up your routes in your ghost settings `Labs -\u003e Routes -\u003e Download current routes.yml`\n- Re-download the Route and edit `routes.yml` line `routes`\n\n[![Kusi Doc Home](./documentation/kusi-doc-home.jpg)](https://raw.githubusercontent.com/godofredoninja/kusi-doc/master/documentation/kusi-doc-home.jpg)\n\n```yaml\nroutes:\n  # Home Page - kusi Doc\n  /:\n    data:\n      post: page.kusi-doc-home\n    template: kusi-doc-home\n```\n\n- In an `HTML` block in your ghost editor add this code for your content.\n\n```html\n  \u003c!-- Description --\u003e\n  \u003cp class=\"mt-6 text-lg text-center leading-normal lg:max-w-xl\"\u003eBeautiful and elegant theme for the documentation of your project.\u003c/p\u003e\n  \u003c!-- Verion --\u003e\n  \u003cp class=\"flex justify-center mt-6 text-sm text-gray-500\"\u003ev1.0\u003c/p\u003e\n```\n\n- Buttons\n\n```html\n  \u003cdiv class=\"md:flex mt-16\"\u003e\n    \u003c!-- Documentation --\u003e\n    \u003ca href=\"http://localhost:2368/docs/\" class=\"flex items-center mt-2 mx-2 px-4 py-2 rounded-lg border text-gray-700 hover:bg-gray-200 hover:border-gray-500\"\u003e\n      \u003csvg class=\"fill-current mr-2 w-4 h-4\"\u003e\u003cuse xlink:href=\"#icon-doc\"\u003e\u003c/use\u003e\u003c/svg\u003e\n      Documentation\n    \u003c/a\u003e\n\n    \u003c!-- Github --\u003e\n    \u003ca href=\"https://github.com/godofredoninja/kusi-doc\" class=\"flex items-center mt-2 mx-2 px-4 py-2 rounded-lg border text-gray-700 hover:bg-gray-200 hover:border-gray-500\"\u003e\n      \u003csvg class=\"fill-current mr-2 w-4 h-4\"\u003e\u003cuse xlink:href=\"#icon-github\"\u003e\u003c/use\u003e\u003c/svg\u003e\n      Source on Github\n    \u003c/a\u003e\n\n    \u003c!-- Blog --\u003e\n    \u003ca href=\"http://localhost:2368/blog/\" class=\"flex items-center mt-2 mx-2 px-4 py-2 rounded-lg border text-gray-700 hover:bg-gray-200 hover:border-gray-500\"\u003e\n      \u003csvg class=\"fill-current mr-2 w-4 h-4\"\u003e\u003cuse xlink:href=\"#icon-rss\"\u003e\u003c/use\u003e\u003c/svg\u003e\n      Blog\n    \u003c/a\u003e\n  \u003c/div\u003e\n```\n\n## Documentation Page\n\nTo create the documentation page is very easy, you have to create an article and choose in template `kusi-doc`. you also have to add the primary tag `docs`.\n\n[![Kusi Doc Post](./documentation/kusi-doc-post.jpg)](https://raw.githubusercontent.com/godofredoninja/kusi-doc/master/documentation/kusi-doc-post.jpg)\n\n:nerd_face: The secondary menu will be used on the documentation page.\n\nSo we need to make some changes to our routes.\n\n:arrow_right: **Doc Collection**\n\n- Appears on: `site.com/docs/`\n- Post URLs: `site.com/docs/my-documentation/`\n- Contains posts with: a `primary_tag` of `docs`\n\n```yaml\ncollections:\n  /docs/:\n    permalink: /docs/{slug}/\n    filter: primary_tag:docs\n```\n\n## Blog Page\n\nTo have a blog page is very easy. Just add a primary tag called `blog` in your articles\n\nSo we need to make some changes to our routes.\n\n:arrow_right: **Blog collection**\n\n- Appears on: `site.com/blog/`\n- Post URLs: `site.com/blog/my-story/`\n- Contains posts with: a `primary_tag` of `blog`\n\n```yaml\ncollections:\n  /blog/:\n    permalink: /blog/{slug}/\n    template: kusi-doc-blog\n    filter: primary_tag:blog\n```\n\n:sweat_smile: If you want to pass content to the blog page as a title and a description.\n\n- Create a new page\n- Choose your favorite title\n- Use the url `kusi-doc-blog` or your favorite url\n\n[![Kusi Doc Blog](./documentation/kusi-doc-blog.jpg)](https://raw.githubusercontent.com/godofredoninja/kusi-doc/master/documentation/kusi-doc-blog.jpg)\n\n```yaml\ncollections:\n  /blog/:\n    permalink: /blog/{slug}/\n    template: kusi-doc-blog\n    filter: primary_tag:blog\n    data:\n      post: page.kusi-doc-blog\n```\n\n## Theme Translation\n\n**Kusi Doc supports:**\n\n- `en` — English default language\n- `es` — Español\n- `tr` — Turkish by [@tolgaaaltas](https://github.com/tolgaaaltas)\n\n![kusi doc theme ghost Language](./documentation/language.jpg)\n\nif you want to have in another language you just have to copy `locales\u003een.json` and rename the file then translate to your favorite language:\n\nJust enter the [language/locale tag](https://www.w3schools.com/tags/ref_language_codes.asp) of the files to use (e.g.: `fr.json` for French, `zh.json` for Chinese, `ja.json` for Japanese)\n\n## PrismJS code syntax\n\nMake your code stand out with the PrismJS code highlighter.\nPrismJS allows you to select which languge you embeded and performs code highlighting according to the language. Neat!\n\nTake a look at the [Prismjs Supported Language List](http://prismjs.com/#languages-list)\n\n## Credits\n\n- [Tailwindcss](https://github.com/tailwindcss/tailwindcss)\n- [Tocbot](https://github.com/tscanlin/tocbot)\n- [Medium Zoom](https://github.com/francoischalifour/medium-zoom)\n- [Prismjs](http://prismjs.com/)\n- [Safari Light - Mockup](https://www.uplabs.com/posts/safari-light-version)\n\n## Copyright \u0026 License\n\nCopyright (c) 2020 GodoFredo - Released under the [MIT license](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodofredoninja%2Fkusi-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgodofredoninja%2Fkusi-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodofredoninja%2Fkusi-doc/lists"}