Skip to content

Commit 26b8acc

Browse files
coderhscoderhs
committed
Initial Commit
0 parents  commit 26b8acc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1866
-0
lines changed

‎.DS_Store

6 KB
Binary file not shown.

‎.gitignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# https://git-scm.com/docs/gitignore
2+
# https://help.github.com/articles/ignoring-files
3+
# Example .gitignore files: https://github.com/github/gitignore
4+
/bower_components/
5+
/node_modules/
6+
/_site/
7+
/.sass-cache/
8+
/.jekyll-metadata
9+
/.brackets.json
10+
/Gemfile

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2015 DigitalMindCH
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Docster
2+
![docster preview](https://raw.githubusercontent.com/DigitalMindCH/docster-jekyll-theme/gh-pages/img/docster_preview.jpg)
3+
4+
## simple and easy
5+
That's how we would describe working with docster.
6+
We first created it, when we needed an index file for a theme documentation. jekyll offered collections which made the organization into smaller chunks of documentation optimal. Especially because the collections did not generate outputs for themselves.
7+
This theme was created to generate an organized output. It does not require any plugins, which means you can host on GitHub without much effort.
8+
9+
## Features
10+
* Nice syntax highlighting
11+
* dynamic multi-level navigation
12+
* Sass stylesheets
13+
14+
### Documentation
15+
We don't believe in delivering Code without explanation. Especially not for a documentation theme. So the [Demo](http://digitalmind.ch/themes/docster-jekyll-theme/demo/) doubles as the documentation for Docster, that should help you set up your own docs without any problems.
16+
17+
### Feedback, Wishes, Problems
18+
If you run into any trouble or have a request please do so by opening up an issue on the theme's GitHub page.
19+
If you just want to give us a general feedback feel free to [contact us!](http://digitalmind.ch/contact/)

‎_config.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
full_rebuild: true
2+
name: Docster Documentation
3+
author: DigitalMind
4+
version: V 1.0
5+
encoding: utf-8
6+
defaults:
7+
-
8+
values:
9+
layout: "index"
10+
markdown: kramdown
11+
kramdown:
12+
input: GFM
13+
relative_permalinks: false
14+
collections:
15+
- entries
16+
sass:
17+
sass_dir: _sass
18+
style: :compressed
19+
exclude: [
20+
.git,
21+
.gitignore,
22+
README.md,
23+
.sass-cache
24+
]

‎_entries/collection-entries.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
sectionclass: h2
3+
sectionid: collection-entries
4+
parent-id: content
5+
is-parent: yes
6+
number: 3100
7+
title: Collection Entries
8+
---
9+
Okay, so the collection is the entries collection. All of your documentation sections will be placed within that folder.
10+
The index file will then go over every one of these and put them together.
11+
12+
There are different ways on how you can take care of the order of the entries, depending on which one you chose, you will either have to work with filenames, or with the `number` front matter.
13+
14+
If you decide to work with file-names, you will just prefix your file names with numbers.

‎_entries/config.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
sectionid: config
3+
sectionclass: h2
4+
parent-id: set-up
5+
title: _config.yml
6+
number: 2100
7+
---
8+
There is very few configuration to be done before you are up and running, still the ones you need to add, are as follows:
9+
10+
In the `_config.yml`-file:
11+
12+
{% highlight yaml %}
13+
# name of the docs
14+
name: Docster Documentation
15+
16+
# docs author
17+
author: DigitalMind
18+
19+
# docs version
20+
version: V 1.0
21+
{% endhighlight %}
22+
23+
All of these infos will be displayed on the top left-hand corner.
24+
25+
Of course you can also go in and change the sass-output-format or change whatever else you want to adjust.

‎_entries/content.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
sectionclass: h1
3+
sectionid: content
4+
is-parent: yes
5+
title: Content
6+
number: 3000
7+
---
8+
Now for what Docster is all about. The content.
9+
10+
You want to know how all of this works, right?
11+
12+
So Docster makes use of the collections feature, every entry will be written separately and then be compiled into one single HTML file. This ensures that the output is minimal. So in case that you don't want to publish the documentation online, it has the perfect format to be put within another folder. Like for example the Download Package of a Theme.

‎_entries/file_names.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
sectionid: filenames
3+
sectionclass: h4
4+
parent-id: order
5+
number: 3121
6+
title: File Names
7+
---
8+
The first option is just prefixing all of your files with file names.
9+
10+
So your files might look something like this:
11+
12+
{% highlight html %}
13+
├── 01 intro.md
14+
│
15+
├── 02 set_up.md
16+
│
17+
├── 02-01 config.md
18+
│
19+
├── 02-02 sass.md
20+
│
21+
├── 03 content.md
22+
│
23+
├── 03-01 collection_entries.md
24+
│
25+
├── 03-01-01 section_types.md
26+
│
27+
├── 03-01-01-01 level_one.md
28+
│
29+
├── 03-01-01-02 level_two.md
30+
│
31+
├── 03-01-01-03 level_three.md
32+
│
33+
├── 03-01-01-04 level_four.md
34+
│
35+
└── and so on...
36+
{% endhighlight %}

‎_entries/front_matter.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
sectionid: frontmatter
3+
sectionclass: h4
4+
parent-id: order
5+
number: 3122
6+
title: Front Matter
7+
---
8+
For the second version, you define a font matter variable `number` So to go with the files from before, this is what this method would look like (under the file name, the front matter.)
9+
10+
{% highlight html %}
11+
├── intro.md
12+
│ └── number: 1000
13+
│
14+
├── set_up.md
15+
│ └── number: 2000
16+
│
17+
├── config.md
18+
│ └── number: 2100
19+
│
20+
├── sass.md
21+
│ └── number: 2200
22+
│
23+
├── content.md
24+
│ └── number: 3000
25+
│
26+
├── collection_entries.md
27+
│ └── number: 3100
28+
│
29+
├── section_types.md
30+
│ └── number: 3110
31+
│
32+
├── level_one.md
33+
│ └── number: 3111
34+
│
35+
├── level_two.md
36+
│ └── number: 3112
37+
│
38+
├── level_three.md
39+
│ └── number: 3113
40+
│
41+
├── level_four.md
42+
│ └── number: 3114
43+
│
44+
└── and so on...
45+
{% endhighlight %}

‎_entries/intro.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
sectionid: intro
3+
sectionclass: h1
4+
title: Introduction
5+
number: 1000
6+
---
7+
Welcome to this demo (and documentation) of Docster. A Documentation Theme for jekyll.
8+
9+
Here we'll show you what the theme looks like and how you will use it. Docster makes setting up an organized Documentation a breeze.
10+
It has a sidebar, that is a table of contents and consists of links, that will scroll you to the respective section.
11+
12+
Docster is perfect for really long and complex as well as short and simple Docs.

‎_entries/level-four.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
sectionid: l-4
3+
sectionclass: h4
4+
parent-id: section-types
5+
number: 3114
6+
title: Level four
7+
---
8+
A Subsection of a level 4 will look like this
9+
10+
{% highlight yaml %}
11+
---
12+
sectionid: UNIQUE-ID
13+
sectionclass: h4
14+
title: TITLE
15+
parent-id: UNIQUE-ID-Of-PARENT
16+
---
17+
{% endhighlight %}
18+
19+
So the `parent-id` is where you will reference the anchor of the h3 section that's your subsections parent.
20+
21+
Level 4 sections can't have any more children within sections, but you if you add a h5 title, it will still have the numbering.
22+
23+
##### Proof here
24+
25+
Told ya! (it will not work on h6 though )

‎_entries/level-one.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
sectionid: l-1
3+
sectionclass: h4
4+
parent-id: section-types
5+
number: 3111
6+
title: Level one
7+
---
8+
If you want to create one of the main sections, you will need to include the following front matter within your entry:
9+
10+
{% highlight yaml %}
11+
---
12+
sectionid: UNIQUE-ID
13+
sectionclass: h1
14+
title: TITLE
15+
---
16+
{% endhighlight %}
17+
18+
If you want your section to have subsections, add
19+
20+
{% highlight yaml %}
21+
is-parent: yes
22+
{% endhighlight %}
23+
24+
The ID is important, because it will be used as the anchor for the scrollToLinks and it is also used within the subsections. So each child needs to tell jekyll what its parent is, before it can be placed correctly.

‎_entries/level-three.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
sectionid: l-3
3+
sectionclass: h4
4+
parent-id: section-types
5+
number: 3113
6+
title: Level three
7+
---
8+
A Subsection of a level 3 will look like this
9+
10+
{% highlight yaml %}
11+
---
12+
sectionid: UNIQUE-ID
13+
sectionclass: h3
14+
title: TITLE
15+
parent-id: UNIQUE-ID-Of-PARENT
16+
---
17+
{% endhighlight %}
18+
19+
So the `parent-id` is where you will reference the anchor of the h2 section that's your subsections parent.
20+
21+
Level 3 sections can have children, the variable to use is the same. To have children add
22+
23+
{% highlight yaml %}
24+
is-parent: yes
25+
{% endhighlight %}

‎_entries/level-two.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
sectionid: l-2
3+
sectionclass: h4
4+
parent-id: section-types
5+
number: 3112
6+
title: Level two
7+
---
8+
A Subsection of a level-2 will look like this
9+
10+
{% highlight yaml %}
11+
---
12+
sectionid: UNIQUE-ID
13+
sectionclass: h2
14+
title: TITLE
15+
parent-id: UNIQUE-ID-Of-PARENT
16+
---
17+
{% endhighlight %}
18+
19+
So the `parent-id` is where you will reference the anchor of the h1 section that's your subsections parent.
20+
21+
Level 2 sections can have children, the variable to use is the same. To have children add
22+
23+
{% highlight yaml %}
24+
is-parent: yes
25+
{% endhighlight %}

0 commit comments

Comments
 (0)