Add CONTRIBUTING.md
This commit is contained in:
parent
cbec2dab86
commit
898900e90d
|
@ -0,0 +1,81 @@
|
|||
# Developer notes
|
||||
|
||||
## Starting a local instance
|
||||
|
||||
This is a mere Jekyll site, and `bundle exec jekyll serve` should be fine. But I suggest you use this instead:
|
||||
|
||||
```
|
||||
make
|
||||
```
|
||||
|
||||
## CSS classes
|
||||
|
||||
`h2` supports these:
|
||||
|
||||
{: .-two-column}
|
||||
{: .-three-column}
|
||||
{: .-wide-second} # combine with -xxx-column
|
||||
{: .-left-reference}
|
||||
|
||||
`h3` supports these:
|
||||
|
||||
{: .-prime}
|
||||
|
||||
`table` supports these:
|
||||
|
||||
{: .-shortcuts}
|
||||
{: .-left-align}
|
||||
{: .-headers}
|
||||
|
||||
`pre` supports these:
|
||||
|
||||
{: .-setup}
|
||||
{: .-box-chars}
|
||||
|
||||
`ul` supports these:
|
||||
|
||||
{: .-also-see}
|
||||
{: .-four-column}
|
||||
{: .-six-column}
|
||||
|
||||
## Frontmatter
|
||||
|
||||
Each sheet supports these metadata:
|
||||
|
||||
```yml
|
||||
---
|
||||
title: React.js
|
||||
layout: 2017/sheet # 'default' | '2017/sheet'
|
||||
|
||||
# Optional:
|
||||
category: React
|
||||
updated: 2017-08-30 # To show in the updated list
|
||||
ads: false # Add this to disable ads
|
||||
weight: -5 # lower number = higher in related posts list
|
||||
deprecated: true # Don't show in related posts
|
||||
prism_languages: [vim] # Extra syntax highlighting
|
||||
---
|
||||
```
|
||||
|
||||
## Prism languages
|
||||
|
||||
For supported prism languages:
|
||||
|
||||
- <https://github.com/PrismJS/prism/tree/gh-pages/components>
|
||||
|
||||
## Setting up redirects
|
||||
|
||||
This example sets up a redirect from `es2015` to `es6`:
|
||||
|
||||
```yml
|
||||
# /es2015.md
|
||||
---
|
||||
title: ES2015
|
||||
category: Hidden
|
||||
redirect_to: /es6
|
||||
---
|
||||
```
|
||||
|
||||
## Localizations
|
||||
|
||||
See `_data/content.yml` for chrome strings.
|
2
Gemfile
2
Gemfile
|
@ -1,2 +1,2 @@
|
|||
source 'https://rubygems.org'
|
||||
gem 'github-pages'
|
||||
gem 'github-pages', group: :jekyll_plugins
|
||||
|
|
82
Readme.md
82
Readme.md
|
@ -14,84 +14,4 @@
|
|||
|
||||
---
|
||||
|
||||
# Dev notes
|
||||
|
||||
## Starting a local instance
|
||||
|
||||
This is a mere Jekyll site, and `bundle exec jekyll serve` should be fine. But I suggest you use this instead:
|
||||
|
||||
```
|
||||
make
|
||||
```
|
||||
|
||||
## CSS classes
|
||||
|
||||
`h2` supports these:
|
||||
|
||||
{: .-two-column}
|
||||
{: .-three-column}
|
||||
{: .-wide-second} # combine with -xxx-column
|
||||
{: .-left-reference}
|
||||
|
||||
`h3` supports these:
|
||||
|
||||
{: .-prime}
|
||||
|
||||
`table` supports these:
|
||||
|
||||
{: .-shortcuts}
|
||||
{: .-left-align}
|
||||
{: .-headers}
|
||||
|
||||
`pre` supports these:
|
||||
|
||||
{: .-setup}
|
||||
{: .-box-chars}
|
||||
|
||||
`ul` supports these:
|
||||
|
||||
{: .-also-see}
|
||||
{: .-four-column}
|
||||
{: .-six-column}
|
||||
|
||||
## Frontmatter
|
||||
|
||||
Each sheet supports these metadata:
|
||||
|
||||
```yml
|
||||
---
|
||||
title: React.js
|
||||
layout: 2017/sheet # 'default' | '2017/sheet'
|
||||
|
||||
# Optional:
|
||||
category: React
|
||||
updated: 2017-08-30 # To show in the updated list
|
||||
ads: false # Add this to disable ads
|
||||
weight: -5 # lower number = higher in related posts list
|
||||
deprecated: true # Don't show in related posts
|
||||
prism_languages: [vim] # Extra syntax highlighting
|
||||
---
|
||||
```
|
||||
|
||||
## Prism languages
|
||||
|
||||
For supported prism languages:
|
||||
|
||||
- <https://github.com/PrismJS/prism/tree/gh-pages/components>
|
||||
|
||||
## Setting up redirects
|
||||
|
||||
This example sets up a redirect from `es2015` to `es6`:
|
||||
|
||||
```yml
|
||||
# /es2015.md
|
||||
---
|
||||
title: ES2015
|
||||
category: Hidden
|
||||
redirect_to: /es6
|
||||
---
|
||||
```
|
||||
|
||||
## Localizations
|
||||
|
||||
See `_data/content.yml` for chrome strings.
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for developer notes.
|
||||
|
|
|
@ -13,6 +13,7 @@ plugins:
|
|||
exclude:
|
||||
- Makefile
|
||||
- README.md
|
||||
- CONTRIBUTING.md
|
||||
- Gemfile
|
||||
- Gemfile.lock
|
||||
- CNAME
|
||||
|
|
Loading…
Reference in New Issue