gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update instructions for translations

Browse Source
This commit is contained in:
mrugesh mohapatra
2018-11-22 01:10:19 +05:30
parent f97bcdf70e
commit ffca835231
1 changed files with 12 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/style-guide-for-guide-articles.md
View File

@ -17,27 +17,12 @@ The titles use a speacial YAML front matter syntax block as shown below. These c
These are the specific front matter requirements: These are the specific front matter requirements:
1. The front matter block should be on the first line of the file. 1. The front matter block should be on the first line of the file.
2. The front matter block should not have whitespaces before and after the lines. 2. The front matter block should not have whitespaces before and after the lines.
3. Each key value pair is separated by one space only 3. The `title` keyword and the string value after the colon (`:`) must only be separted by a single space.
4. If the article is a translation from the english version, the front matter block should also have a `titleLocale` keyword with appilicable translation for the english title.
Here are some examples of properly named titles: Here are some examples of properly named titles:
> [`src/pages/html/tables/index.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/src/pages/html/tables/index.md) > [`guide/english/javascript/loops/for-loop/index.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/guide/english/javascript/loops/for-loop/index.md)
```markdown
---
title: Tables
---
```
> [`src/pages/css/borders/index.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/src/pages/css/borders/index.md)
```markdown
---
title: Borders
---
```
> [`src/pages/javascript/loops/for-loop/index.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/src/pages/javascript/loops/for-loop/index.md)
```markdown ```markdown
--- ---
@ -45,6 +30,15 @@ title: For Loop
--- ---
``` ```
> [`guide/spanish/algorithms/binary-search-trees/index.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/guide/spanish/algorithms/binary-search-trees/index.md)
```
---
title: Binary Search Trees
localeTitle: Árboles binarios de búsqueda
---
```
## Modularity ## Modularity
Each article should explain exactly one concept, and that concept should be apparent from the article's title. Each article should explain exactly one concept, and that concept should be apparent from the article's title.