This is a website for KC group. Please contact KC for maintainence.
This website uses jekyll as a static website generator. Jekyll will render the markdown posts in _posts/ folder. Some important things to notice:
-
Posts file name has be
YEAR-MO-DA-TITLE.md. -
In the beginning of each file you should add the following block:
--- title: Title secid: secitonid order: somenumber ---titleis for the text that show in navbar, doesn't need to be the same with post title.secidis for the webpage to target the posistion to scroll to, needs a unique name but not important.orderis for how you order the posts in the webite. -
Use the special element
<clear />I created to clear issues with floating images. -
You may edit online at github directly. Github supports markdown language by default so you could preview how it looks.
-
If you are familiar with
git, you could also edit locally and push the changes to the repository. See github tutorial for more information.
Markdown is an intuitive and fast way for content editing. The following is a simple guide. There is also a more complete guide here.
Headers
The website supports two different headers.
Section Header
==============
Subsection Header
-----------------
You may also use # for headers.
# Section Header
## Subsection Header
Note that markdown supports up to six different headers with #. However, for header 2~6 #s are the same in this website style.
Emphasis
There are two text styling supported: bold and italic.
**bold** or __bold__
*italic* or _italic_
Lists
There are unordered list and ordered list, both very simple with markdown.
Unordered List
* This is an example
* of unordered list
* you may use *, + and -.
Ordered List
1. This is
2. an example
3. of ordered list.
Linebreaks
A single return in markdown is not considered a new paragraph. Remember to use more than two returns for separate paragraph.
Links
There are two ways for creating links, inline or reference.
Inline-style
This is an [inline link](http://example.com).
This is an [inline link](http://example.com "Optional Title").
Reference-style
This is a [reference link][1].
[1]: http://example.com "Optional Title"
Images
Images are a little less natural in markdown. However, it can still be done as follow.
Inline-style
Reference-style
![Alt text][1]
[1]: img/image.jpg "Optional Title"
Escaping
As you can see, a lot of symbols have functionality in markdown. To show them as what they are, you may use \ to escape the symbols. Symbols that needs escaping are:
\ ` * _ {} [] () # + - . !
Data in img/ and _post/ are copyrighted by KC group. All other code are Code released under the Apache 2.0 license. Styling uses Bootstrap (Agency) and Font Awesome.