Skip to content

Commit 1e75c26

Browse files
Adding your own article 101
1 parent f458ead commit 1e75c26

File tree

3 files changed

+64
-1
lines changed

3 files changed

+64
-1
lines changed
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
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+
![aze](https://i.imgur.com/3JVIa5i.png)
21+
22+
- 2 - Clone it to your workspace or machine.
23+
![](https://i.imgur.com/iNV3Uo5.png)
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+
![](https://i.imgur.com/5nK1FOJ.png)
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+
![](https://i.imgur.com/XjV0Pn9.png)
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+
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"title": "How To Add Your Own Article",
3+
"description": "This tutorial will show you how to add your own article to DzCode",
4+
"image": "https://i.imgur.com/SqhMCpV.png&fit=crop&w=800&q=100"
5+
}

data/articles/list.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"items": ["Welcome_to_dzCode", "Test_Article"],
2+
"items": ["Welcome_to_dzCode", "Test_Article", "Add_Your_Own_Article"],
33
"include": ["title"]
44
}

0 commit comments

Comments
 (0)