Getting Started
---------------
### List Card {.col-span-2}
- Share quick reference
- Cheatsheet for developers
...
{.style-timeline}
### Table Card
| id | name |
|----|---------|
| 1 | Roberta |
{.show-header}
Getting Started
Create source/_posts/demo.md
Syntax Variants
- Section Variants
- Card Variants
- Table Variants
- List Variants
- Code Variants
- Paragraph Variants
- Cards Example All the magic variants supported by QuickRef.ME
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
- Clone Repository View on Github
$ git clone https://github.com/Fechin/reference.git
- Install Dependencies in the project directory
$ npm install
- Start a Dev Server http://localhost:4000
$ 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