Release the latest generator

This commit is contained in:
fechin committed 2022-11-16 14:10:09 +08:00
1 parent b520119d38
commit 15c93e54ee
484 files changed
+4969 -856

No files matched your search

+12 -6
View File
@@ -9,24 +9,30 @@ ehthumbs.db
Thumbs.db
nohup.out
# Python files #
######################
.python-version
.env
.venv
.ipynb_checkpoints
*.log
uploads/
# Editor files #
######################
.idea
.vscode
# templates files #
# Node files #
######################
node_modules/
dist/
public/
npm-debug.log*
yarn-debug.log*
yarn-error.log*
package-lock.json
db.json
# Other files #
######################
public/
db.json
-26
View File
@@ -1,26 +0,0 @@
# Contributing
Thanks for your interest on contributing to reference 👍👍, it's people like you that make [QuickRef.ME](https://quickref.me) such a amazing site 🎉🎉. Feel free to [submit issues](https://github.com/Fechin/reference/issues/new?assignee=Fechin) and enhancement requests.
A `{filename}.md` file will be processed into a cheat sheet, let's create or edit a markdown file:
#### Front Matter
```markdown
---
title: QuickRef
date: 2020-11-25 18:28:43
icon: icon-style
background: bg-emerald-600
tags:
categories:
- Other
intro: This is a reference of styles that you can use on quickref cheatsheets!
---
```
Just need `title` and `intro`, and ignore other options. I will complete it if it can be released.
#### CSS classes
QuickRefs uses [markdown-it-attrs](https://github.com/arve0/markdown-it-attrs) and supports adding classes via its syntax. Also, there is a reference of styles that you can use on `quickref.me` cheat sheets: https://quickref.me/quickref
At last, It's a good practice to refer to the source code of the existing cheat sheet!
+64 -3
View File
@@ -1,7 +1,16 @@
# Reference
Share quick reference cheat sheet for developers.
If you see a cheatsheet here is not fit, you can fix it or provide a better cheatsheet by submitting a PR.
[![love](https://badgen.net/badge/make with/love/pink)](#)
[![License](https://badgen.net/badge/license/MIT/blue)](https://github.com/Fechin/reference/blob/main/LICENSE)
[![License](https://badgen.net/github/stars/Fechin/reference)](#)
[![License](https://badgen.net/github/forks/Fechin/reference)](#)
[![License](https://badgen.net/github/contributors/Fechin/reference)](#)
**Reference** is a collection of **cheatsheets** contributed by open source angels. It shares a quick reference cheat sheet for developers in a beautiful layout.
We're happy to see your best skill cheat sheets in **Reference**, If you see a cheatsheet here is not fit, you can fix it or provide a better cheatsheet by submitting a PR.
## Live Demo
@@ -11,9 +20,61 @@ Read the cheatsheet gracefully https://quickref.me
## Directory structure
```
.
├── source
│ ├── _posts # Source file for cheatsheet
│ │ ├── bash.md
│ │ ├── chmod.md
│ │ ├── ...
│ └── widget # Widget that can be referenced
│ └── chmod.html
├── public # Static files for distribution
├── _config.yml
├── gulpfile.js
├── package.json
├── postcss.config.js
├── tailwind.config.js
└── themes
└── coo # Hexo's theme
```
## Contributing
See [the contribution guide](https://github.com/Fechin/reference/blob/main/CONTRIBUTING.md) for ways to get started.
Thanks for your interest on contributing to reference 👍👍, it's people like you that make [QuickRef.ME](https://quickref.me) such a amazing site 🎉🎉. Feel free to [submit issues](https://github.com/Fechin/reference/issues/new?assignee=Fechin) and enhancement requests.
#### Development setup
1. Clone Github repo `git clone https://github.com/Fechin/reference.git`
2. Install `npm` package manager (Read [installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm))
3. Run `npm install` in the root folder to install dependencies.
4. Run `npm run dev` to start a dev server. This serves the project and live reloads when any files are changed, then visit http://127.0.0.1:4000 preview.
5. Send us pull request and chill.
A `source/_posts/{filename}.md` file will be processed into a cheat sheet, let's create or edit a markdown file:
#### Front Matter
```markdown
---
title: QuickRef
date: 2020-11-25 18:28:43
icon: icon-style
background: bg-emerald-600
tags:
categories:
- Other
intro: This is a reference of styles that you can use on quickref cheatsheets!
---
```
Just need `title` and `intro`, and ignore other options. I will complete it if it can be released.
#### CSS classes
QuickRefs uses [markdown-it-attrs](https://github.com/arve0/markdown-it-attrs) and supports adding classes via its syntax. Also, there is a reference of styles that you can use on `quickref.me` cheat sheets: https://quickref.me/quickref
At last, It's a good practice to refer to the source code of the existing cheat sheet!
<a href="https://github.com/Fechin/reference/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Fechin/reference" />
+160
View File
@@ -0,0 +1,160 @@
# Hexo Configuration
## Docs: https://hexo.io/docs/configuration.html
## Source: https://github.com/hexojs/hexo/
# Site
title: QuickRef.ME
subtitle: 'Quick Reference Cheat Sheet'
description: 'Share quick reference and cheat sheet for developers'
keywords: reference,cheatsheet,code table,snippets,linux
author: QuickRef.ME
language: en
timezone: ''
# URL
## If your site is put in a subdirectory, set url as 'http://yoursite.com/child' and root as '/child/'
url: https://quickref.me
root: /
permalink: :name.html
permalink_defaults:
pretty_urls:
trailing_index: false # Set to false to remove trailing 'index.html' from permalinks
trailing_html: false # Set to false to remove trailing '.html' from permalinks
# Directory
source_dir: source
public_dir: public
#tag_dir: tag
archive_dir: archives
#category_dir: node
#code_dir: downloads/code
i18n_dir: :lang
skip_render:
- "assets/**/*"
- "_posts/README.md"
- "_posts/CONTRIBUTING.md"
# Writing
new_post_name: :title.md # File name of new posts
default_layout: post
titlecase: false # Transform title into titlecase
external_link:
enable: true # Open external links in new tab
field: site # Apply to the whole site
exclude: ''
filename_case: 1
render_drafts: false
post_asset_folder: false
relative_link: false
future: true
highlight:
enable: false
# Home page setting
# path: Root path for your blogs index page. (default = '')
# per_page: Posts displayed per page. (0 = disable pagination)
# order_by: Posts order. (Order by date descending by default)
index_generator:
path: ''
per_page: 0
order_by: -date
# Category & Tag
default_category: uncategorized
category_map:
tag_map:
# Metadata elements
## https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta
meta_generator: false
# Date / Time format
## Hexo uses Moment.js to parse and display date
## You can customize the date format as defined in
## http://momentjs.com/docs/#/displaying/format/
date_format: YYYY-MM-DD
time_format: HH:mm:ss
## Use post's date for updated date unless set in front-matter
updated_option: 'date'
# Pagination
## Set per_page to 0 to disable pagination
per_page: 10
pagination_dir: page
# Include / Exclude file(s)
## include:/exclude: options only apply to the 'source/' folder
include:
exclude:
- ".github"
ignore:
# Extensions
## Plugins: https://hexo.io/plugins/
## Themes: https://hexo.io/themes/
theme: coo
nofollow:
enable: true
field: site
exclude:
- 'exclude1.com'
excerpt:
depth: 2
excerpt_excludes: []
more_excludes: []
hideWholePostExcerpts: true
# Deployment
## Docs: https://hexo.io/docs/deployment.html
deploy:
# - type: cjh_google_url_submitter
- type: cjh_bing_url_submitter
- type: cjh_baidu_url_submitter
# hexo-server configuration
server:
# Solve the problem that occasional real-time refresh is invalid and long articles are truncated
compress: true
# https://github.com/hexojs/hexo-generator-sitemap#options
sitemap:
path: sitemap.xml
tags: false
categories: false
# hexo-related-popular-posts
# https://github.com/tea3/hexo-related-popular-posts/wiki/More-Settings#popular-posts
popularPosts:
googleAnalyticsAPI:
clientId: 122889019292-92h297ceb29qnv9ulvgabad6q5kgv0an.apps.googleusercontent.com
serviceEmail: quickref-service@decent-courage-275204.iam.gserviceaccount.com
key: google-services-private-key.pem
viewId: 242826463
dateRange: 30 # (Optional) The period you want to get by Google Analytics page view. Default = 30
expiresDate: 10 # (optional) Expiration date of cache file. Default = 10
# cache: # (Deprecated) This options is Deprecated > v0.1.3
# path: hexo-related-popular-posts-ga-cached.json # (Deprecated) This options is Deprecated > v0.1.3
# expiresDate: 10 # (Deprecated) This options is Deprecated > v0.1.3
# Markdown-it configuration
## Docs: https://github.com/celsomiranda/hexo-renderer-markdown-it/wiki
markdown:
render:
html: true
xhtmlOut: false
breaks: false
linkify: false
typographer: false
quotes: '“”‘’'
anchors:
level: 2
collisionSuffix: ''
permalink: true
permalinkClass: h-anchor
permalinkSymbol: '#'
case: 1
separator: '-'
+37
View File
@@ -0,0 +1,37 @@
const gulp = require('gulp');
const htmlmin = require('gulp-htmlmin');
const htmlclean = require('gulp-htmlclean');
const version = require('gulp-version-number');
const terser = require('gulp-terser');
// Compress js files
gulp.task('js', function () {
return gulp.src(['./public/js/main.js'])
.pipe(terser({
compress: true
}))
.pipe(gulp.dest('./public/js'));
});
// Build html files
gulp.task('html', function () {
return gulp.src('./public/**/*.html')
.pipe(htmlclean())
.pipe(htmlmin({
removeComments: true,
minifyJS: true,
minifyCSS: true,
minifyURLs: true,
}))
.pipe(version({
'append': {
'key': '_v',
'cover': 1,
'to': ['css', 'js', 'png', 'jpg', 'woff2']
}
}))
.pipe(gulp.dest('./public'));
});
gulp.task('default', gulp.parallel('js', 'html'));
+76
View File
@@ -0,0 +1,76 @@
{
"name": "QuickRef.ME",
"version": "1.0.0",
"private": true,
"scripts": {
"dev": "run-p dev:*",
"dev:hexo": "npx hexo clean && npx hexo server",
"dev:css": "npx postcss themes/coo/source/css/style.tailwindcss -o themes/coo/source/css/style.css --watch",
"build": "run-s build:*",
"build:clean": "npx hexo clean",
"build:css": "npx postcss themes/coo/source/css/style.tailwindcss -o themes/coo/source/css/style.css",
"build:generate": "npx hexo generate",
"build:cache": "npm cache clean --force",
"build:gulp": "npx gulp --max-old-space-size=4096"
},
"hexo": {
"version": "5.4.2"
},
"dependencies": {
"eslint": "^8.27.0",
"gulp": "^4.0.2",
"gulp-cli": "^2.3.0",
"gulp-ext-replace": "^0.3.0",
"gulp-htmlclean": "^2.7.22",
"gulp-htmlmin": "^5.0.1",
"gulp-minify-css": "^1.2.4",
"gulp-postcss": "^9.0.1",
"gulp-uglify-es": "^3.0.0",
"gulp-version-number": "^0.2.4",
"hexo": "^5.4.0",
"hexo-browsersync": "^0.3.0",
"hexo-cli": "^4.3.0",
"hexo-excerpt": "^1.2.1",
"hexo-filter-nofollow": "^2.0.2",
"hexo-generator-index": "^2.0.0",
"hexo-generator-sitemap": "^2.2.0",
"hexo-log": "^3.0.0",
"hexo-pagination": "^2.0.0",
"hexo-related-popular-posts": "^5.0.1",
"hexo-renderer-ejs": "^2.0.0",
"hexo-renderer-markdown-it": "^5.0.0",
"hexo-renderer-stylus": "^2.0.1",
"hexo-server": "^2.0.0",
"markdown-it-abbr": "^1.0.4",
"markdown-it-anchor": "^8.4.1",
"markdown-it-attrs": "^4.1.0",
"markdown-it-checkbox": "^1.1.0",
"markdown-it-emoji": "^2.0.0",
"markdown-it-footnote": "^3.0.3",
"markdown-it-highlight-lines": "^1.0.2",
"markdown-it-highlightjs": "^3.5.0",
"markdown-it-ins": "^3.0.1",
"markdown-it-multimd-table": "^4.1.1",
"markdown-it-shortcode-tag": "^1.1.0",
"markdown-it-sub": "^1.0.0",
"markdown-it-sup": "^1.0.0",
"markdown-it-task-lists": "^2.1.1"
},
"devDependencies": {
"autoprefixer": "^10.4.0",
"gulp-clean-css": "^4.3.0",
"gulp-filesize": "^0.0.6",
"gulp-javascript-obfuscator": "^1.1.6",
"gulp-replace": "^1.1.3",
"gulp-rev": "^9.0.0",
"gulp-terser": "^2.1.0",
"npm-run-all": "^4.1.5",
"postcss": "^8.4.4",
"postcss-cli": "^9.1.0",
"postcss-import": "^14.0.2",
"postcss-minify": "^1.1.0",
"sync-request": "^6.1.0",
"tailwindcss": "^3.0.1",
"tailwindcss-cli": "^0.1.2"
}
}
+8
View File
@@ -0,0 +1,8 @@
module.exports = {
plugins: {
'postcss-import': {path: 'themes/coo/source/css'},
'tailwindcss': {config: './tailwind.config.js'},
'autoprefixer': {},
'postcss-minify':{},
}
};
+6
View File
@@ -0,0 +1,6 @@
---
title: {{ title }}
date: {{ date }}
categories:
tags:
---
+4
View File
@@ -0,0 +1,4 @@
---
title: {{ title }}
date: {{ date }}
---
+16
View File
@@ -0,0 +1,16 @@
---
title: {{ title }}
date: {{ date }}
icon: icon-{{ title }}
background: bg-blue-400
tags:
-
categories:
-
intro:
---
+6
View File
@@ -0,0 +1,6 @@
---
title: {{ title }}
date: {{ date }}
categories:
tags:
---
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
File renamed without changes.
File renamed without changes.
View File
File renamed without changes.
File renamed without changes.
View File
File renamed without changes.
File renamed without changes.
View File
File renamed without changes.
File renamed without changes.
View File
File renamed without changes.
File renamed without changes.
File renamed without changes.
View File
File renamed without changes.
File renamed without changes.
View File
File renamed without changes.
File renamed without changes.
View File
File renamed without changes.
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
View File
File renamed without changes.
File renamed without changes.
Loaded 100 of 484 files, more files were not shown because too many files have changed in this diff. Show more