V-Squared / V-Squared.github.io

Initiative for Modular and Upgradable Mini and All-In-One PC. Standards — Know How — Blueprints — Trailblazer Products
http://v-squared.github.io/
Other
2 stars 1 forks source link

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

Open VillageHubertChen opened 8 years ago

VillageHubertChen commented 8 years ago

Generic Tasks

Note Issue Number

VillageHubertChen commented 8 years ago

Specs for Article

Philosophy

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

Markdown WritingAppetizing 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 ArticlesKramdown Syntax