Addy-Wiki

Official Documentation Website for Addy, based on a Jekyll Theme named Paper

Website hosted at https://addy-org.github.io/Wiki

Gitter channel link

https://gitter.im/addy-org

Contribution Guidelines

https://addy-org.github.io/Wiki/contribution-guidelines

Running the site in your local system

git clone https://github.com/addy-org/Wiki
bundle install
rake preview

Then, go to your favourite browser and type in the address http://127.0.0.1:YOUR_PORT_NUM_HERE

Adding Documentations

For adding a documentation, just create a new file in the _documentations folder. It will automatically be listed in the docs section. Follow the below format.

Note: The file name will be the link of the post you added, like https://addy-org.github.io/Wiki/<FILE_NAME>/

---
layout: post
title: "<YOUR-TITLE-HERE>"
description: "<WRITE-A-SHORT-DESCRIPTION-ABOUT-THE-POST>"
tags: <INDIVIDUAL-TAGS-SEPARATED-BY-SPACE>
comments: true
---

<YOUR-CONTENT-HERE-IN-GITHUB-FLAVOURED-MARKDOWN>

Adding Pages

For adding a new page, create a new file in the _pages folder. A page is not listed automatically, you have to link it to appropriate places.

---
layout: content
title: "<YOUR-TITLE-HERE>"
description: "<WRITE-A-SHORT-DESCRIPTION>" //optional
permalink: /<LINK-TO-THE-POST>/
---

<YOUR-CONTENT-HERE-IN-GITHUB-FLAVOURED-MARKDOWN>

Getting Started with Contributing:

https://addy-org.github.io/Wiki/newcomers-guide