Skip to content

Latest commit

 

History

History
166 lines (119 loc) · 3.43 KB

README.md

File metadata and controls

166 lines (119 loc) · 3.43 KB

Hexo Cheatsheets Theme

This project is using Percy.io for visual regression testing. Netlify Status Commitizen friendly Codacy Badge CodeFactor

A new cheatsheets theme for Hexo. The design is from devhints

Installation

Install

$ git clone https://github.com/glazec/hexo-cheatsheets.git

Enable

Modify theme setting in _config.yml to hexo-cheatsheets.

Disable default code highlight plugin in _config.yml.

highlight:
  enable: false

Update

cd themes/hexo-cheatsheets
git pull

Configuration

favicon: "favicon url"
github: "the link the github button point to"
githubToolTip: "Text displayed when hovering on the github button"
recommend:
  enable: true # whether to open the top

Writing

Code

when using tht code block in the markdown, please write the language. Otherwise the highlight will not work. The following example is correct.(Please omit the last dot, thant is a render issue)

```yml
favicon: "favicon url"
github: "the link the github button point to"
githubToolTip: "Text displayed when hovering on the github button"
```·

Three Columns

### Three Columns

```bash
cd themes/hexo-cheatsheets
git pull
```

Two Columns

#### Two Columns

```bash
cd themes/hexo-cheatsheets
git pull
```

Single Column

##### Single Columns

```bash
cd themes/hexo-cheatsheets
git pull
```

Secondary Title

### Three Columns

```bash
cd themes/hexo-cheatsheets
git pull
```

###### Secondary Title

```bash
cd themes/hexo-cheatsheets
git pull
```

Captions & URL

### Three Columns

```bash
cd themes/hexo-cheatsheets
git pull
```
Hexo [Cheatsheets](https://github.com/glazec/hexo-cheatsheets) Theme 

```bash
cd themes/hexo-cheatsheets
git pull
```
> [Cheatsheets](https://github.com/glazec/hexo-cheatsheets)

Introduction List

###  References

1. [Hexo](https://hexo.io/) _(hexo.io)_

2. [Hexo Cheatsheets](https://github.com/glazec/hexo-cheatsheets) _(hexo-cheatsheets)_

Must be an ordered list !

Table & Headless Table

### Table

| Shortcut | Description         |
| -------- | ------------------- |
| `⌘\`     | Toggle tree         |
| `⌘⇧\`    | Reveal current file |

### Headless Table

|          |                     |
| -------- | ------------------- |
| `⌘\`     | Toggle tree         |
| `⌘⇧\`    | Reveal current file |

Roadmap

IMAGE ALT TEXT HERE