-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsubmitting_posts.html
133 lines (91 loc) · 5.77 KB
/
submitting_posts.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
---
layout: page
title: Submitting Posts
---
<p>Anyone can submit any topics, videos or blogposts to Kodermine. Kodermine's content heavily depends on the Kodermine community. All our blog posts are created by our Kodermine members.</p>
<p>This is a guide on how <strong>YOU</strong> can start to contribute and make Kodermine more awesome!</p>
<h2>Requirements</h2>
<ul>
<li>Github Account</li>
<li>Text Editor/Markdown Editor (optional)</li>
<li>Basic knowledge of Git(optional), watch our tutorial <a href="http://kodermine.com/git/2014/05/18/git_basics/">here</a> to get started</li>
<li>Basic knowledge HTML/Markdown</li>
<li>Basic knowledge about Jekyll(optional)</li>
</ul>
<h2>Directory Structure</h2>
<p>We use Jekyll for our blog, but it's not really mandatory to know what jekyll is or how jekyll works.</p>
<p>In our Github Repo there's a <code>master</code> branch and there's a <code>jekyll</code> branch. The <code>master</code> branch contains all the static files and assets and the <code>jekyll</code> branch contains all the configurations, templates and also blog posts.</p>
<p>The branch that get's published to our website is the <code>master</code> branch.</p>
<p><a href="https://pages.github.com/">Learn more about publishing on Github</a>.</p>
<p>When submitting blog posts, we're gonna be making pull-requests to the jekyll branch so that it can be genrated and published.</p>
<p>Jekyll Branch Directory Structure</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text"> - _assets (contains all the asset files)
- javascripts (javascript fiiles)
- stylesheets (stylesheet files)
- _includes (included files)
- _layouts (layout templates)
- _plugins (jekyll plugins)
- _posts (where the blog posts are, this is where we're gonna spend most of our time on)
- _site (the generated static site)
- images
</code></pre></div>
<h2>Submitting a Post through Github</h2>
<p>Go to the <a href="https://github.com/Kodermine/kodermine.github.io">Github repo</a> for the blog.</p>
<ul>
<li>To submit a blog post, we have to switch to the jekyll branch</li>
</ul>
<p><img src="https://cloud.githubusercontent.com/assets/2405577/3021980/307150f8-dfbe-11e3-830d-e7f23b493bf4.gif" alt="switching_branches"></p>
<ul>
<li>After switching branches we should go to the <code>_posts</code> folder, the <code>_posts</code> folder contains all the blog posts on our Kodermine Blog.</li>
</ul>
<p><img src="https://cloud.githubusercontent.com/assets/2405577/3022064/1f99257e-dfc0-11e3-86af-1ea8d167f57c.gif" alt="go_to_posts"></p>
<ul>
<li><p>Create a new post by clicking the new file icon, and name it with the current date and the title of the post with the <code>.md</code>(markdown) file extension. E.g.</p>
<p><code>2014-05-20-hello_world.md</code></p>
<p>The title is important because it's going to be parsed as the permalink of the post.</p></li>
</ul>
<p><img src="https://cloud.githubusercontent.com/assets/2405577/3022108/32136ec0-dfc1-11e3-86b8-68ac7ef2c2f0.gif" alt="create_new_post"></p>
<ul>
<li>If you get to view some of the posts, you will notice that it has data on top of the file which looks like this.</li>
</ul>
<div class="highlight"><pre><code class="text language-text" data-lang="text">---
layout: post
title: Title
subtitle: "Subtitle."
youtube: youtube_link
cover_image: cover_image
excerpt: "Insert excerpt here"
category: "category"
author:
name: Your Name
twitter: twitter_handle
gplus: google_plus_id
bio: title
image: your_photo
---
</code></pre></div>
<p>These are used by our templates to display information about the post and the author.</p>
<h3>Post information</h3>
<p><code>title</code> - The title of the page (required)</p>
<p><code>subtitle</code> - The text that appears below it inside a blogpost (optional)</p>
<p><code>youtube</code> - The embed link for the youtube video (optional)</p>
<p><code>cover_image</code> - A cover image for the blog post (optional)</p>
<p><code>excerpt</code> - An excerpt of the text from the blog post written, this is used when the post is being displayed on the index page, and also used for SEO descriptions (required)</p>
<p><code>category</code> - The category of the post E.g. <code>ruby</code>, <code>git</code>, <code>tutorial</code>. It could one or many. (optional)</p>
<h3>Author information</h3>
<p><code>name</code> - Your name (required)
<code>twitter</code> - Your twitter handle (optional)
<code>gplus</code> - Your googleplus id (optional)
<code>bio</code> - Your title E.g <code>guru</code>, <code>co-founder</code></p>
<p>Example posts:</p>
<p><a href="http://kodermine.com/git/2014/05/19/cool_stuff_with_git/">Post with Video</a></p>
<p><a href="http://kodermine.com/ruby/2014/04/27/intro_to_ruby/">Post with Cover Image</a></p>
<p>Go ahead and copy the header information to the text box and fill in your information.</p>
<ul>
<li>After filling in your information, you can start writting your blog post. You can use HTML or Markdown to add headers, images, and code excerpts to your page. I prefer that we use markdown for most of the blog post, and only use HTML when it is really needed.</li>
</ul>
<p><a href="http://markdowntutorial.com/">Learn more about writting Markdown</a></p>
<p>You can now submit the post by clicking "Propose new file" on the bottom of the page. Make sure that you fill in the appropriate description.</p>
<p><img src="https://cloud.githubusercontent.com/assets/4141598/3022313/4851063e-dfc6-11e3-8fa3-899226695767.gif" alt="submit_file"></p>
<p>All blog posts submitted will go through a review process, we will make comments on the proposal that you've made to inform you if it has been accepted or declined.</p>
<a href="https://github.com/Kodermine/kodermine.github.io" class="btn-lg btn-outline">SUBMIT A POST</a>