Skip to content

Commit 87982b0

Browse files
committed
Re-integrated old landing page as docs welcome
1 parent a153a98 commit 87982b0

11 files changed

Lines changed: 54 additions & 1130 deletions

File tree

EDITING-INSTRUCTIONS.md

Lines changed: 4 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,9 @@
22
unpublished: true
33
---
44

5-
## Getting started
5+
This site uses the Jekyll-doc theme, see its [documentation]
6+
(https://aksakalli.github.io/jekyll-doc-theme/docs/home/) for editing instructions.
67

7-
[GitHub Pages](https://pages.github.com) can automatically generate and serve the website for you.
8-
Let's say you have a username/organisation `my-org` and project `my-proj`; if you locate Jekyll source under `docs` folder of master branch in your repo `github.com/my-org/my-proj`, the website will be served on `my-org.github.io/my-proj`.
9-
The good thing about coupling your documentation with the source repo is, whenever you merge features with regarding content to master branch, it will also be published on the webpage instantly.
8+
# Customizations
109

11-
1. Just [download the source](https://github.com/aksakalli/jekyll-doc-theme/archive/gh-pages.zip) into your repo under `docs` folder.
12-
2. Edit site settings in `_config.yml` file according to your project. !!! `baseurl` should be your website's relative URI like `/my-proj` !!!
13-
3. Replace `favicon.ico` and `img/logonav.png` with your own logo.
14-
15-
## Writing content
16-
17-
### Docs
18-
19-
Docs are [collections](https://jekyllrb.com/docs/collections/) of pages stored under `_docs` folder. To create a new page:
20-
21-
**1.** Create a new Markdown as `_docs/my-page.md` and write [front matter](https://jekyllrb.com/docs/frontmatter/) & content such as:
22-
23-
```
24-
---
25-
title: My Page
26-
permalink: /docs/my-page/
27-
---
28-
29-
Hello World!
30-
```
31-
32-
**2.** Add the pagename to `_data/docs.yml` file in order to list in docs navigation panel:
33-
34-
```
35-
- title: My Group Title
36-
docs:
37-
- my-page
38-
```
39-
40-
### Blog posts
41-
42-
Add a new Markdown file such as `2017-05-09-my-post.md` and write the content similar to other post examples.
43-
44-
### Pages
45-
46-
The homepage is located under `index.html` file. You can change the content or design completely different welcome page for your taste. (You can use [bootstrap components](http://getbootstrap.com/components/))
47-
48-
In order to add a new page, create a new `.html` or `.md` (markdown) file under root directory and link it in `_includes/topnav.html`.
10+
Instead of a "blog" section we have a "show-case" section with posts-style.

_data/docs.yml

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
1-
- title: Getting Started
1+
- title: General
22
docs:
3-
- home
4-
- themes
5-
- customization
6-
7-
- title: Examples
8-
docs:
9-
- cheatsheet
10-
- font-awesome
11-
- bootstrap
3+
- home
124

135
- title: Concepts
146
docs:

_docs/customization.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)