Skip to content

Commit

Permalink
additional details, documentation, structure and skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
w00fz committed Mar 6, 2013
1 parent 6124d44 commit 76e1071
Show file tree
Hide file tree
Showing 19 changed files with 386 additions and 21 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
/.DS_Store
/Docs/.DS_Store
.DS_Store
4 changes: 4 additions & 0 deletions Docs/TOC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* [Joomla](joomla)
* [Wordpress](wordpress)
* [Magento](magento)
* [phpBB](phpbb)
41 changes: 41 additions & 0 deletions Docs/joomla/INDEX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Joomla! Documentation
landing: true
---

* [Basic](basic/)

- [Getting Started](basic/)
- [FAQ](basic/faq.md)

<!-- -->

* Club Extensions

- [RokBox](extensions/rokbox/)

<!-- -->

* Free Extensions

- [RokPad](extensions/rokpad/)

<!-- -->

* Templates

- [Chapelco](templates/chapelco)
- [Lumiere](templates/lumiere)
- [Leviathan](templates/leviathan)
- [Cerulean](templates/cerulean)
- [Metropolis](templates/metropolis)
- [Graffito](templates/graffito)
- [Fracture](templates/fracture)
- [Kirigami](templates/kirigami)
- [Ximenia](templates/ximenia)
- [Fresco](templates/fresco)
- [Voxel](templates/voxel)
- [Diametric](templates/diametric)
- [Ionosphere](templates/ionosphere)
- [Clarion](templates/clarion)
- [Halcyon](templates/halcyon)
13 changes: 13 additions & 0 deletions Docs/joomla/basic/INDEX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Getting Started
parent_title: Return to Joomla! Docs
---

Getting Started
===============
Getting started with RocketTheme


How to install a Joomla! template
----------------------------------
Content goes here.
7 changes: 7 additions & 0 deletions Docs/joomla/basic/TOC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Basic
---

* Basic
* [Getting Started]()
* [FAQ](faq.md)
13 changes: 13 additions & 0 deletions Docs/joomla/basic/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: FAQ
parent_title: Return to Joomla! Docs
---

FAQ
===
Frequently Asked Questions


How to install a Joomla! template
----------------------------------
Details on how to install a Joomla! tempalte...
3 changes: 3 additions & 0 deletions Docs/joomla/extensions/REDIRECT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
redirect_to: ../
---
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions Docs/joomla/extensions/rokbox/INDEX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: RokBox
parent: ../../
parent_title: Return to Joomla! Docs
---

RokBox
======
RokBox is a very powerful popup that handles many media formats such as *images* and *videos*

![](assets/featured.jpg)


How to install
--------------
Content goes here.


How to Use
-----------
Using RokBox is extremely simple. Have a look at the [Editor Button](editor_button.md) page.
3 changes: 3 additions & 0 deletions Docs/joomla/extensions/rokbox/TOC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* RokBox
* [Introduction]()
* [Editor Button](editor_button.md)
19 changes: 19 additions & 0 deletions Docs/joomla/extensions/rokbox/editor_button.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Editor Button
parent: ../../
parent_title: Return to Joomla! Docs
---

RokBox Editor Button
====================
RokBox has a built-in editor button that can be used to easily integrate RokBox links into your content.

From the Editor Button popup you can customize every option available in RokBox and even pick the images you want to be linked or show as a thumbnail [^1].


Create a simple linked image
----------------------------
From the Editor Button popup, under the `Link` field, pick the image you want to show.


[^1]: This is a foot note
14 changes: 14 additions & 0 deletions Docs/joomla/extensions/rokpad/INDEX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: RokPad
parent: ../../
parent_title: Return to Joomla! Docs
---

RokPad
======
Description goes here.


How to install
--------------
Content goes here.
3 changes: 3 additions & 0 deletions Docs/joomla/templates/REDIRECT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
redirect_to: ../
---
File renamed without changes.
Empty file added Docs/phpbb/.gitkeep
Empty file.
Empty file added Docs/wordpress/.gitkeep
Empty file.
107 changes: 88 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,107 @@
RocketTheme Documentation
========================

=========================
This repository contains the source of the RocketTheme documentation, currently accessible at [http://rockettheme.com/docs]().

The documentation is contained in [Docs/](Docs/) and is structured in folders, exactly as you see them on the main website.
The documentation is contained in [Docs/](Docs) and is structured in folders, exactly as you see them on the main website.

You can read all of the documentation within as its just in plain text files, marked up with [Markdown](http://daringfireball.net/projects/markdown/).

If you would like a local copy of the documentation, you can either [download it](https://github.com/rockettheme/docs/archive/master.zip) or you can clone the reopistory by running the follwing command:

git clone git://github.com/rockettheme/docs rockettheme-docs

Contributing
-----------------
~~~
git clone git://github.com/rockettheme/docs rockettheme-docs
~~~

Contributing to the documentation is very simple. Feel free to fork the repository, add your changes and give back by issuing a pull request. You can even edit the docs directly on github, without having to ever download the files. Make sure to follow the conventions before issuing a pull request.

Contributing
------------
Contributing to the documentation is very simple. Feel free to fork the repository, add your changes and give back by issuing a pull request. You can even edit the docs directly on GitHub, without having to ever download the files. Make sure to follow the conventions before issuing a pull request.

You are also very welcome to make any suggestions or report any kind of problem with the documentation by opening a new [Issue](https://github.com/rockettheme/docs/issues/new).

If you decide to fork for providing new content as commits. Please ensure you create a branch for your changes, before making them. This will make the process of integrating them more easier.
If you decide to fork for providing new content as commits. Please ensure you create a branch for your changes, before making them. This will make the process of integrating them more easier. Every change must pass through the `staging` branch first, so please ensure your pull-requests are directed to the proper branch.

Conventions
-----------------
To get started with a local environment into the proper `staging` branch, you can run these commands:

~~~
git clone git://github.com/rockettheme/docs rockettheme-docs
cd rockettheme-docs
git checkout -b staging origin/staging
~~~


Conventions
-----------
This is a list of few conventions we follow when writing documentation that help keep the repository well organized and consistent. Feel free to use any other file in the docs as reference. We also have a [skelethon](Skelethon.md) with all the conventions in place and with many examples of Markdown in use.

* Every change/pull request must be applied or requested to the [dev branch](https://github.com/rockettheme/docs/tree/dev). Once reviewed, approved and pulled, it will get merged into the **master** branch and automatically picked up by the website.
* Every change/pull request must be applied or requested to the [staging branch](https://github.com/rockettheme/docs/tree/staging). Once reviewed, approved and pulled, it will get merged into the **master** branch and automatically picked up by the website.

* Folder and file names must be written in snake_case. For example, if you wanted to convert “How to Install” in snake_case, you would name it “how_to_install”.

* There are some reserved names that can’t be used for anything but the scope they are intended for:
* **README.md**: [_file_] This is a reserved name of GitHub, used to describe the content of a particular repository directory, like this you are reading right now.

* **TOC.md**: [_file_] TOC (Table Of Content) does represent the structure of a project. Its content is a list of links to the various documents in the project. The TOC is represented as sidebars in the [RocketTheme Docs](http://rockettheme.com/docs).

* **INDEX.md**: [_file_] This file defines the default content for a folder. Exatly like HTML pages, if you hit a folder without specifying any file, INDEX.md (if found) will be assumed.

* **REDIRECT.md**: [_file_] This file sorely purpose is to redirect projects to different locations. For example, if a project `/docs/project/subproject/` contains a `REDIRECT.md`, when hitting on the web the `subproject` page, you’ll get redirect to `project`. By default it takes you back one level, although you can configure where to redirect to through YAML headers ([read more about YAML headers below](#yaml-headers)).

* **ASSETS**: [_folder_] When the project requires assets, such as images, they can be placed in the `ASSETS` folder. Any filename inside `ASSETS` must follow the same rules as any other file name (snake_case, no reserved names, etc).

* Every header, except for the title one, must be precedenced by 2 empty lines and succeeded by no empty line.

* Headers sub lines (`=` and `-`) must always align to the header text. Because this can easily get confusing, be sure to use a mono-spaced fonts. Here a couple of examples of well aligned headers:

~~~
Header H1
=========
Header H2
---------
~~~
YAML Headers
------------
Our Markdown implementation uses special [YAML headers](http://www.yaml.org/spec/1.2/spec.html). These headers are encapsuled in between a set of three dashes and an empty line. This is how a YAML header looks like:
~~~ .yaml
---
title: Project Title
parent: ../../
parent_title: Return to the Generic Projects
---
~~~

The headers allow for a much flexible output. For example we can define a title of a Markdown file based on its header title variable, rather than the file name itself.

Below is a list of supported YAML variables that can be used and a description on what they do:

* **title**: The title of the article. This is used whenever a page needs to be referenced.

~~~
---
title: Hello World!
---
~~~
* **parent**: _(defaults: ../)_ This is the reference for the back link to point to.
~~~
---
parent: ../extensions/
---
~~~
* **parent_title**: _(defaults: Return to the previous Documentation)_ The text to be associated to the `parent`.
~~~
---
parent_title: Back to Extensions!
---
~~~
* Folder and file names must be written in snake_case. For example if you wanted to convert “How to Install” in snake_case, you would name it “how_to_install”.
If you have any question feel free to open an [Issue](https://github.com/rockettheme/docs/issues/new).
* There are reserved names that can’t be used for anything but the scope they are intended for:
* `README.md`: This is a reserved name of GitHub, used to describe the content of a particular repository directory, like this you are reading right now.
* `TOC.md`: TOC (Table Of Content) does usually resides alone at the top level of a directory. Its content is a list of links to the subfolders. This is represented as sidebars in the [RocketTheme Docs](http://rockettheme.com/docs).
* `INDEX.md`: This file defines the default content for a folder. Exatly like HTML pages, if you hit a folder without specifying any file, INDEX.md (if found) will be assumed.


_The RocketTheme Team_
78 changes: 78 additions & 0 deletions Skelethon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
title: Skelethon Title
parent: ../../
parent_title: Skeleton Back Link
---

Header H1
=========
Paragraph below H1.


Header H2
---------
Paragraph below H2.

* This is
* an Unordered
* List

1. This is
2. an Ordered
3. List

Paragraph with **bold text** , _italic text_ and `inline code`.

An horizontal rule

* * *

Another paragraph with a [link](#url-goes-here), an automatic link <http://example.com>, a [^1] and a [link reference][ref].

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.
Another blockquote example.

> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.
Blocks of code.

~~~ .html
<!DOCTYPE HTML>
<html>
<head>
<title>I am a Title</title>
</head>
<body>
<div class="content">
<h1>Lorem Ipsum</h1>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
</div>
</body>
</html>
~~~

### Header 3
An Image Example

![Alt Text](http://octodex.github.com/images/plumber.jpg "Optional Title")


[^1]: Footnote

[ref]: http://example.com
Loading

0 comments on commit 76e1071

Please sign in to comment.