Skip to content

Commit

Permalink
Issue techjoomla#9 feat: Usage Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
Lakhan Mandloi committed Feb 8, 2018
1 parent e703c52 commit b50e740
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Techjoomla Documentation Site

Steps to contribute documentation to the Techjoomla Site.
Steps to contribute documentation to the Techjoomla Site.

## Git Fork Setup on local machine

Expand All @@ -25,19 +25,27 @@ Steps to contribute documentation to the Techjoomla Site.
### Adding a New Post

1. Start the development server with command ```bundle exec jekyll serve```
2. It will give you the link where you can see the changes.
2. It will give you the link where you can see the changes. In most of the cases it is ```http://127.0.0.1:4000```
3. Inside _post folder create a new md file format ```YYYY-MM-DD-filename.md```
4. Open the same file you created and add front matter
```
---
date: 2017-01-15
title: Post Title
description: Post Description
pageTitle: Page Title
categories:
- CategoryName
tags:
- Tag 1
- Tag 2
type: Document
nav_ordering: 2
showSidebar: true
published: true
---
```
title & description are used as meta data of page and also used on homepage and related post data. showSidebar adds page on homepage and sidebar, in case of its absence or false value it will not be added. nav_ordering is the ordering value of the menu under its category.
5. This will add a section on homepage with Category name and a post under it. The post will be generated with url - ```domainname.com/categoryname/filename```
6. Add below the front matter your content to be added on that post. To know markdown follow [this link](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)

Expand All @@ -54,6 +62,9 @@ Steps to contribute documentation to the Techjoomla Site.
categories:
- CategoryName
type: Video
nav_ordering: 2
showSidebar: true
published: true
---
```

Expand Down

0 comments on commit b50e740

Please sign in to comment.