Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V² > Plan > Flow > Publishing > Article Template #214

Open
9 of 10 tasks
VillageHubertChen opened this issue Jul 18, 2016 · 1 comment
Open
9 of 10 tasks

V² > Plan > Flow > Publishing > Article Template #214

VillageHubertChen opened this issue Jul 18, 2016 · 1 comment

Comments

@VillageHubertChen
Copy link
Member

VillageHubertChen commented Jul 18, 2016

Generic Tasks

  • Create Issue
  • Add Link to Article in Reference of this Issue
  • Classify Labels, Milestone & Assignee
  • Create Article
  • Create Title / Subtitle / Abstract
  • Enter Issue No in Article

Hubert's Tasks

Tom's Tasks

Reference

Note Issue Number

@VillageHubertChen
Copy link
Member Author

VillageHubertChen commented Jul 18, 2016

Specs for Article

Philosophy

This is a template that includes all supported structured elements. This template is written and used in context with:

Markdown Writing
Appetizing Articles

Purpose of Markdown Writing

This is the companion to the Article Template. Whereas the Article Template only presents all structured elements, this article adds additional information and for each structured element shows the markdown source code.

Purpose of Appetizing Articles

It gives you all the details on Appetizing. This is in contrast to the template, which just gives you possible implementation of the elements listed in "Appetizing Articles"

How to write the Article

Step 1: YAML Front Matter

I already created the YML front matter. All you need to do is to add the Manual Table of Contents. For logistic reasons you will have to do it when your article is finished.

Step 2: Kramdown Elements

Go through Kramdown Syntax. For each Element create an entry as Heading 1 and then write about it and style it accordingly. In the template you do this very succinct and without the source code example. Instead in the companion article: Markdown Writing you will copy the full text of the kramdown syntax article and you add the source code block. In the template you link to the section in the companion article for quick look up if needed when using the template.

Step 3: Appetizing Elements

Repeat step 2, only for Appetizing Articles

Your Reference

Appetizing Articles
Kramdown Syntax

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants