iskm/learnxinyminutes-docs
1
0
Fork 0
mirror of https://github.com/adambard/learnxinyminutes-docs.git synced 2025-04-27 07:33:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Boris Verkhovskiy 2024-12-18 09:35:21 -07:00
parent 7cc7891403
commit 89b5d9277f
2 changed files with 9 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -3,4 +3,3 @@
- [ ] Pull request touches only one file (or a set of logically related files with similar changes made) - [ ] Pull request touches only one file (or a set of logically related files with similar changes made)
- [ ] Content changes are aimed at *intermediate to experienced programmers* (this is a poor format for explaining fundamental programming concepts) - [ ] Content changes are aimed at *intermediate to experienced programmers* (this is a poor format for explaining fundamental programming concepts)
- [ ] If you've changed any part of the YAML Frontmatter, make sure it is formatted according to [CONTRIBUTING.md](https://github.com/adambard/learnxinyminutes-docs/blob/master/CONTRIBUTING.md) - [ ] If you've changed any part of the YAML Frontmatter, make sure it is formatted according to [CONTRIBUTING.md](https://github.com/adambard/learnxinyminutes-docs/blob/master/CONTRIBUTING.md)
- [ ] Yes, I have double-checked quotes and field names!

22
CONTRIBUTING.md
View File

@ -31,13 +31,6 @@ review them more effectively and/or individually.
language in question. language in question.
* Keep articles succinct and scannable. We all know how to use Google here. * Keep articles succinct and scannable. We all know how to use Google here.
* **Use UTF-8** * **Use UTF-8**
* For translations (or EN articles with non-ASCII characters) please ensure
your file is UTF-8 encoded.
* Leave out the byte-order-mark (BOM) at the start of the file (in Vim, use
`:set nobomb`).
* You can check if the file contains a BOM on Linux/Unix systems by running
`file language.html.markdown` You will see this if it uses a BOM:
`UTF-8 Unicode (with BOM) text`.
### Header configuration ### Header configuration
@ -48,29 +41,32 @@ called frontmatter.
The following fields are necessary for English articles about programming The following fields are necessary for English articles about programming
languages: languages:
* **name** The human-readable name of the programming language * `name`: The human-readable name of the programming language
* **contributors** A list of [author, URL] lists to credit * `contributors`: A list of [*author*, *URL*] lists to credit, *URL* is optional
Other fields: Other fields:
* **category**: The category of the article. So far, can be one of *language*, * `category`: The category of the article. So far, can be one of *language*,
*tool* or *Algorithms & Data Structures*. Defaults to *language* if omitted. *tool* or *Algorithms & Data Structures*. Defaults to *language* if omitted.
* **filename**: The filename for this article's code. It will be fetched, mashed * `filename`: The filename for this article's code. It will be fetched, mashed
together, and made downloadable. together, and made downloadable.
Translations should also include:
* `translators`: A list of [*translator*, *URL*] lists to credit, *URL* is optional
Non-English articles inherit frontmatter values from the English article (if it exists) Non-English articles inherit frontmatter values from the English article (if it exists)
but you can overwrite them. but you can overwrite them.
Here's an example header for Ruby: Here's an example header for Ruby:
```yaml ```yaml
*-- ---
name: Ruby name: Ruby
filename: learnruby.rb filename: learnruby.rb
contributors: contributors:
- ["Doktor Esperanto", "http://example.com/"] - ["Doktor Esperanto", "http://example.com/"]
- ["Someone else", "http://someoneelseswebsite.com/"] - ["Someone else", "http://someoneelseswebsite.com/"]
*-- ---
``` ```
### Syntax highlighter ### Syntax highlighter