Skip to content

Commit 2249354

Browse files
committed
add welcome page
1 parent 795a6ef commit 2249354

File tree

2 files changed

+62
-2
lines changed

2 files changed

+62
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
# jekyll-minimal-theme
1+
# What's `jekyll-minimal-theme`?
22

3+
It's another minimal(istic) Jekyll static site generator theme,
4+
that is, a ready-to-fork template pack.
35

4-
Another minimial Jekyll theme - [Live Demo @ `feedreader.github.io/jekyll-minimal-theme` »](http://feedreader.github.io/jekyll-minimal-theme/)
6+
See a live demo @ [`feedreader.github.io/jekyll-minimal-theme` »](http://feedreader.github.io/jekyll-minimal-theme/)
7+
8+
For example:
59

610
```
711
├── _config.yml # site configuration

_posts/2015-01-31-welcome.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
layout: post
3+
title: "Welcome to jekyll-minimal-theme - Another Minimal Jekyll Theme"
4+
---
5+
6+
What's `jekyll-minimal-theme`?
7+
8+
It's another minimal(istic) Jekyll static site generator theme,
9+
that is, a ready-to-fork template pack. For example:
10+
11+
~~~
12+
├── _config.yml # site configuration
13+
├── _posts # sample blog posts
14+
| ├── 2014-05-05-sportdb-update-v192.md # filename format:
15+
| ├── 2014-10-10-new-repo-baviria-bayern.md # => YEAR-MONTH-DAY-TITLE.MARKUP
16+
| ├── 2014-10-21-sql-views.md
17+
| ├── 2014-11-11-new-reop-maps.md
18+
| └── 2014-12-15-quick-starter-datafiles.md
19+
├── _layouts
20+
| ├── default.html # master layout template
21+
| └── post.html # single blog post template
22+
├── css
23+
| ├── _settings.scss # style settings (e.g. variables)
24+
| └── style.scss # master style page
25+
├── feed.xml # web feed template (e.g. in atom format)
26+
├── archive.html # archive template
27+
└── index.html # index template
28+
~~~
29+
30+
will result in (with `permalink: /:title.html`):
31+
32+
~~~
33+
└── _site # output build folder; site gets generated here
34+
├── css
35+
| └── style.css # styles for pages (copied 1:1 as is)
36+
├── sportdb-update-v192.html # blog post page
37+
├── new-repo-baviria-bayern.html # another blog post page
38+
├── sql-views.html # ""
39+
├── new-repo-maps.html # ""
40+
├── quick-starter-datafiles.html # ""
41+
├── feed.xml # web feed (e.g. in atom format)
42+
├── archive.html # archive page
43+
└── index.html # index page
44+
~~~
45+
46+
To use - delete all sample posts in the `_posts` folder and
47+
change the settings in `_config.yml` to use your own `site.title`
48+
and `site.url`:
49+
50+
~~~
51+
title: 'Jekyll Minimal Theme'
52+
url: 'http://feedreader.github.io/jekyll-minimal-theme'
53+
author:
54+
name: 'Jekyll Minimal Theme Team'
55+
~~~
56+

0 commit comments

Comments
 (0)