Getting Started

Create source/_posts/demo.md

Getting Started
---------------
### List Card {.col-span-2}
- Share quick reference
- Cheatsheet for developers
...
{.style-timeline}
### Table Card
| id | name    |
|----|---------|
| 1  | Roberta |
{.show-header}

Cheatsheet Structure

.
├── Section 1
│   ├── Card 1
│   ├── Card 2
│   ├── Card 3
│   ├── ...
├── Section 2
│   ├── Card 1
│   │   ├── Paragraph
│   │   ├── Code
│   │   ├── <hr/> (aka "---")
│   │   ├── List
│   │   │   ├── Paragraph
│   │   │   └── Code
│   │   └── Table
│   │       ├── Paragraph
│   │       └── Code
│   ├── Card 2
│   ├── Card 3
│   └── ...
├── Section 3
├── Section 4
└── ...

  • One cheatsheet contains multiple sections
  • One section contains multiple cards
  • One card can contain Code, Table, List and Paragraph
  • One list can contain Code and Paragraph
  • One table can contain Code and Paragraph

Directory Structure

.
├── source
│   ├── \_posts   # Cheatsheet source files
│   │   ├── awk.md
│   │   ├── vim.md # => quickref.me/vim
│   │   ├── php.md
│   │   ├── css.md # => quickref.me/css
│   │   ├── ...
│   └── widget   # Widget files
│       └── chmod.html
├── public       # Distribution files
├── \_config.yml
├── gulpfile.js
├── package.json
├── postcss.config.js
├── tailwind.config.js
└── themes
    └── coo      # Theme files

Develop Setup

$ git clone https://github.com/Fechin/reference.git
  • Install Dependencies in the project directory
$ npm install
$ npm run dev
  • Create or modify source/_posts/{name}.md
  • Send us pull request and chill It's a good practice to refer to the source code of the QuickRef cheatsheet.
Comments