https://github.com/erlzhang/jekyll-theme-arktos

Minimalist Jekyll Theme
https://github.com/erlzhang/jekyll-theme-arktos

jekyll jekyll-theme

Last synced: about 2 months ago
JSON representation

Minimalist Jekyll Theme

• Host: GitHub
• URL: https://github.com/erlzhang/jekyll-theme-arktos
• Owner: erlzhang
• License: mit
• Created: 2019-01-10T04:52:48.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-10T03:31:27.000Z (almost 6 years ago)
• Last Synced: 2024-09-08T14:27:42.048Z (5 months ago)
• Topics: jekyll, jekyll-theme
• Language: CSS
• Homepage:
• Size: 218 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Arktos

[![Gem Version](https://badge.fury.io/rb/jekyll-theme-arktos.svg)](https://badge.fury.io/rb/jekyll-theme-arktos)

A minimalist Jekyll theme arktos.

![jekyll-theme-arktos](screenshot.png)

Your can find a demo [here](https://erlzhang.github.io/arktos-demo/)!

[中文文档](http://yexiqingxi.com/blog/jekyll-theme-arktos.html)

## Installation

Add this line to your Jekyll site's `Gemfile`:

```ruby

gem "jekyll-theme-arktos"

```

And add this line to your Jekyll site's `_config.yml`:

```yaml

theme: jekyll-theme-arktos

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install jekyll-theme-arktos

### If you are using Github Pages?

Add the following to your site’s `_config.yml` file.

```yml

remote_theme: erlzhang/jekyll-theme-arktos

```

## Usage

### Compatible with  jekyll-paginate-v2

But you should enable it in your `_config.yml`.

```yml

pagination:

  enabled: true

```

### Enabling Excerpts on the Home Page

To display post-excerpts on the Home Page, simply add the following to your `_config.yml`:

```yml

arktos:

  excerpt: true

```

### How to use mermaid?


```mermaid

graph TD;

    A-->B;

    A-->C;

    B-->D;

    C-->D;

```



## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/erlzhang/jekyll-theme-arktos. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).