https://github.com/godofredoninja/kusi-doc
:smile: Beautiful and elegant theme for the documentation
https://github.com/godofredoninja/kusi-doc
blog documentation ghost-blog-theme ghost-cms ghost-theme theme theme-development
Last synced: 19 days ago
JSON representation
:smile: Beautiful and elegant theme for the documentation
- Host: GitHub
- URL: https://github.com/godofredoninja/kusi-doc
- Owner: godofredoninja
- License: mit
- Created: 2020-03-14T16:48:16.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-30T04:27:41.000Z (over 5 years ago)
- Last Synced: 2024-02-29T18:33:50.935Z (almost 2 years ago)
- Topics: blog, documentation, ghost-blog-theme, ghost-cms, ghost-theme, theme, theme-development
- Language: HTML
- Homepage: https://godofredo.ninja
- Size: 1.61 MB
- Stars: 22
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kusi Doc free theme for [Ghost](https://github.com/tryghost/ghost/)
[](https://github.com/TryGhost/Ghost)
[](https://www.paypal.me/godofredoninja)
[](https://www.buymeacoffee.com/GodoFredoNinja)
> *Kusi Doc is a beautiful and elegant theme for the documentation of your project.*
Hello :smile: , I created this theme for the documentation of your project.
It 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)
## 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&hosted_button_id=Y7UB5Q8GVN3HN&source=url). It'll help motivate me to update the theme with many improvements
[](https://www.paypal.me/godofredoninja)
: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.
[](https://godofredo.ninja)
[](https://raw.githubusercontent.com/godofredoninja/kusi-doc/master/documentation/doc-blog.jpg)
## Featured
- Support for different [languages](http://themes.ghost.org/docs/i18n#section-how-to-add-any-language) (en - es)
- Previous and next Post
- Table of Content for documentation post
- YouTube, Vimeo, kickstarter, dailymotion => Responsive
- Code syntax [Prismjs](http://prismjs.com/index.html#languages-list) Supported all syntax
## Table of Contents
- [Web Browser Support for Kusi Doc](#web-browser-support-for-kusi-doc)
- [Ghost Settings](#ghost-settings)
- [Home Page](#home-page)
- [Documentation Page](#documentation-page)
- [Blog Page](#blog-page)
- [Theme Translation](#theme-translation)
- [PrismJS code syntax](#prismjs-code-syntax)
## Web Browser Support for Kusi Doc
Kusi Doc supports the following web [browsers](http://caniuse.com/#search=flexbox).
## Ghost Settings
Enable the following checkbox on the Labs page in the Ghost admin panel.
## Home Page
- Create a new page
- Choose your favorite title
- Use the url `kusi-doc-home` or your favorite url
- First back up your routes in your ghost settings `Labs -> Routes -> Download current routes.yml`
- Re-download the Route and edit `routes.yml` line `routes`
[](https://raw.githubusercontent.com/godofredoninja/kusi-doc/master/documentation/kusi-doc-home.jpg)
```yaml
routes:
# Home Page - kusi Doc
/:
data:
post: page.kusi-doc-home
template: kusi-doc-home
```
- In an `HTML` block in your ghost editor add this code for your content.
```html
Beautiful and elegant theme for the documentation of your project.
v1.0
```
- Buttons
```html
```
## Documentation Page
To 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`.
[](https://raw.githubusercontent.com/godofredoninja/kusi-doc/master/documentation/kusi-doc-post.jpg)
:nerd_face: The secondary menu will be used on the documentation page.
So we need to make some changes to our routes.
:arrow_right: **Doc Collection**
- Appears on: `site.com/docs/`
- Post URLs: `site.com/docs/my-documentation/`
- Contains posts with: a `primary_tag` of `docs`
```yaml
collections:
/docs/:
permalink: /docs/{slug}/
filter: primary_tag:docs
```
## Blog Page
To have a blog page is very easy. Just add a primary tag called `blog` in your articles
So we need to make some changes to our routes.
:arrow_right: **Blog collection**
- Appears on: `site.com/blog/`
- Post URLs: `site.com/blog/my-story/`
- Contains posts with: a `primary_tag` of `blog`
```yaml
collections:
/blog/:
permalink: /blog/{slug}/
template: kusi-doc-blog
filter: primary_tag:blog
```
:sweat_smile: If you want to pass content to the blog page as a title and a description.
- Create a new page
- Choose your favorite title
- Use the url `kusi-doc-blog` or your favorite url
[](https://raw.githubusercontent.com/godofredoninja/kusi-doc/master/documentation/kusi-doc-blog.jpg)
```yaml
collections:
/blog/:
permalink: /blog/{slug}/
template: kusi-doc-blog
filter: primary_tag:blog
data:
post: page.kusi-doc-blog
```
## Theme Translation
**Kusi Doc supports:**
- `en` — English default language
- `es` — Español
- `tr` — Turkish by [@tolgaaaltas](https://github.com/tolgaaaltas)
if you want to have in another language you just have to copy `locales>en.json` and rename the file then translate to your favorite language:
Just 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)
## PrismJS code syntax
Make your code stand out with the PrismJS code highlighter.
PrismJS allows you to select which languge you embeded and performs code highlighting according to the language. Neat!
Take a look at the [Prismjs Supported Language List](http://prismjs.com/#languages-list)
## Credits
- [Tailwindcss](https://github.com/tailwindcss/tailwindcss)
- [Tocbot](https://github.com/tscanlin/tocbot)
- [Medium Zoom](https://github.com/francoischalifour/medium-zoom)
- [Prismjs](http://prismjs.com/)
- [Safari Light - Mockup](https://www.uplabs.com/posts/safari-light-version)
## Copyright & License
Copyright (c) 2020 GodoFredo - Released under the [MIT license](LICENSE)