|
| 1 | +# How To Add Your Own Article |
| 2 | +This Tutorial will show you how to add your own article on our website [DzCode.io](https://dzcode.io) |
| 3 | + |
| 4 | + |
| 5 | +# Requirments : |
| 6 | + |
| 7 | +You don't need much to write and add an article to our website, ALL you need is a <b><i>Good Article</i></b>. |
| 8 | + |
| 9 | +## What does a good article look like ? |
| 10 | + |
| 11 | +A good article requires good <b>content</b> and good <b>technique</b>. It means your article needs to be informative, easy to read and appealing. |
| 12 | + |
| 13 | +# Write the article : |
| 14 | + |
| 15 | +Articles on [dzCode.io](https://dzcode.io) are found under the folder `data/articles` of our [dzcode.io Github repo](https://github.com/dzcode-io/dzcode.io/tree/master/data/articles). |
| 16 | + |
| 17 | +To add new article simply do the following: |
| 18 | + |
| 19 | +- 1 - Fork the repo [Fork](https://github.com/dzcode-io/dzcode.io/fork). |
| 20 | +  |
| 21 | + |
| 22 | +- 2 - Clone it to your workspace or machine. |
| 23 | +  |
| 24 | + |
| 25 | +- 3 - Create a new folder `MyNewAricleName` under `data/articles` |
| 26 | + |
| 27 | +> on this example our article will be named " How To Add Your Own Article " |
| 28 | +
|
| 29 | +- 4 - Add 2 files, `info.json` and `content.md` |
| 30 | + |
| 31 | + - `info.json` : A Json file containing info about your article, like title, description etc... |
| 32 | + |
| 33 | + check this [File](https://github.com/dzcode-io/dzcode.io/blob/master/data/articles/Welcome_to_dzCode/info.json) as an example. |
| 34 | + |
| 35 | + - `content.md` , a markdown file which contain your Article text, in form of markdown. |
| 36 | + |
| 37 | +  |
| 38 | + |
| 39 | +- 5 - Make your modifications and add your Article content. |
| 40 | + |
| 41 | +- 6 - Make your article visible by adding the name of the article into the `"items": [] array` on `list.json` under `data/articles`. |
| 42 | + |
| 43 | +  |
| 44 | + |
| 45 | +- 7 - Commit and push the modifications you did to the repository and create a `pull request`. |
| 46 | + |
| 47 | +<h3><b><i> And CONGRATS ! you have added your own article to our website. </h3></i></b> |
| 48 | + |
| 49 | +> it won't be published until one of the admins accepts the Pull Request and validate your modifications. |
| 50 | +
|
| 51 | + |
| 52 | +© 2020 - DzCode - Making the world a better place 🌎 |
| 53 | + |
| 54 | + |
| 55 | + |
| 56 | + |
| 57 | + |
| 58 | + |
0 commit comments