Added support for git-doc
This commit is contained in:
2
support/changelog.md
Normal file
2
support/changelog.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
### 2013/06/15
|
||||||
|
+ Some example changes
|
2
support/faq.md
Normal file
2
support/faq.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
### is this a question?
|
||||||
|
An answer
|
5
support/gitdoc.json
Normal file
5
support/gitdoc.json
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"googleGroup": "group_name",
|
||||||
|
"irc": {"server": "irc.freenode.net", "channel": "#a_channel"},
|
||||||
|
"domain": "yoursite.com"
|
||||||
|
}
|
2
support/guide/overview.md
Normal file
2
support/guide/overview.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
This directory is useful for many things, like how to install your software, if it has a CLI you
|
||||||
|
can tell people how to use it, any many other uses.
|
14
support/reference/layout.md
Normal file
14
support/reference/layout.md
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
### Navigation
|
||||||
|
On the documentation/guide/reference pages, the sections created in your reference and guide
|
||||||
|
directories will be listed on the right as the main navigation links, you can have subsections too.
|
||||||
|
Any h3(###) lines you include in your reference/guide files will be added to the subsections under
|
||||||
|
the main section link. They will be hidden until you hover over the main section link or have
|
||||||
|
clicked the section link.
|
||||||
|
|
||||||
|
### Headers
|
||||||
|
You can use any size headers you want, but it is adivised to use h3(###) and smaller, anything
|
||||||
|
bigger than h3(e.g. h2) is usually too big for the default layout.
|
||||||
|
|
||||||
|
### Scrolling
|
||||||
|
When you scroll down the page the navigation will follow you if the screen is big enough for the
|
||||||
|
navigation to fit on the right side, otherwise it sits at the top.
|
27
support/reference/premium.md
Normal file
27
support/reference/premium.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
### Premium repositories
|
||||||
|
Once you get premium, the plan you selected delegates the number of premium repositories you're
|
||||||
|
allowed to have. Premium repositories have many features not available without a premium plan.
|
||||||
|
|
||||||
|
### Personally hosted repositories
|
||||||
|
The premium repositories you select are allowed to be hosted on their own domains, you can choose
|
||||||
|
a domain in your `support/gitdoc.json` file. Just add a `domain` field with your domain, and
|
||||||
|
point your domain at our site, and it will automatically load your repo.
|
||||||
|
|
||||||
|
### Private repositories
|
||||||
|
Private repositories cannot be viewed without being set as a premium repository.
|
||||||
|
|
||||||
|
### Custom CSS
|
||||||
|
You're premium repos can have custom layouts through CSS. Once you add a premium repo, simply create
|
||||||
|
the file `support/styles.css` and refresh your repo, when the page refreshes you'll be able to
|
||||||
|
see the custom CSS in action.
|
||||||
|
|
||||||
|
### Branches
|
||||||
|
On premium repositories, you can select the branch you want to pull updates from, this is useful
|
||||||
|
if you plan to display the documentation for a specific version of your software.
|
||||||
|
|
||||||
|
### Standard Git repos
|
||||||
|
Standard Git repositories from non Github servers are supported after you have a premium plan.
|
||||||
|
To add a standard repo to your account, add support for the repository(You can get the setup
|
||||||
|
details from your profile page.), after that go to your profile page and at the bottom will be
|
||||||
|
a form where you can fill out the information to add your repository. After that it can be updated
|
||||||
|
just like any other repository.
|
71
support/tutorial.md
Normal file
71
support/tutorial.md
Normal file
@ -0,0 +1,71 @@
|
|||||||
|
### Introduction
|
||||||
|
After you run the command on the profile page a basic setup is created for you, including this
|
||||||
|
tutorial and a few other files. These files include content describing some of the details on
|
||||||
|
how to format the content.
|
||||||
|
|
||||||
|
### Adding support
|
||||||
|
If you used the script to generate the support files, you can skip this section.
|
||||||
|
|
||||||
|
In your repository to add support you'll need the `support` directory, inside this directory
|
||||||
|
you will need to create a `gitdoc.json` file. This file contains details about the repository.
|
||||||
|
```
|
||||||
|
$ mkdir support/
|
||||||
|
$ touch support/gitdoc.json
|
||||||
|
```
|
||||||
|
The other files in the `support` directory are optional, only `gitdoc.json` is required.
|
||||||
|
|
||||||
|
The following sections describe the information needed in the files.
|
||||||
|
|
||||||
|
### gitdoc.json
|
||||||
|
There are a few fields in this file that make it easy to give your viewers extra details about
|
||||||
|
the community, as well as the domain for premium repos.
|
||||||
|
|
||||||
|
#### googleGroup
|
||||||
|
This is a field you can use to give your viewers a link to your google group. Just set the field
|
||||||
|
to the name of your google group, and we'll create the link. It isn't required though, you can
|
||||||
|
leave it out safely.
|
||||||
|
|
||||||
|
#### irc
|
||||||
|
This is a field you can use to give your viewers the details to join your irc channel. To use it
|
||||||
|
set an `object` with two fields. One of the fields is `server`, this is the server address for the
|
||||||
|
irc network(e.g. `irc.freenode.net` for the freenode network). The next is the `channel` field,
|
||||||
|
this tells the viewers the specific channel for your community. The channel requires you to
|
||||||
|
include the prefix character though(e.g. #, &, +, !), since there are multiple.
|
||||||
|
|
||||||
|
#### domain
|
||||||
|
This is a field you can use if your repository is premium. It tells us the name of the domain
|
||||||
|
for your repo, so we can get your repo if we detect a custom domain. You can ignore it, or just
|
||||||
|
set a placeholder if it's not premium yet.
|
||||||
|
|
||||||
|
#### analytics
|
||||||
|
When you view the repo from a custom premium domain, if this field is given it'll include the
|
||||||
|
Google Analytics snippet to track page views. This value should be your GA web property ID.
|
||||||
|
|
||||||
|
### changelog.md
|
||||||
|
This file is just a markdown file displaying the changelog for your repository. For details on
|
||||||
|
the markdown, view the default documentation created. This file can be safely ignored if you don't
|
||||||
|
want to include a changelog page.
|
||||||
|
|
||||||
|
### faq.md
|
||||||
|
This file is just a markdown file displaying the frequently asked questions for your repository.
|
||||||
|
For details on the markdown, view the default documentation created. This file can be safely
|
||||||
|
ignored if you don't want to include a faq page.
|
||||||
|
|
||||||
|
### tutorial.md
|
||||||
|
This file is just a markdown file displaying the tutorial for your repository. For details on the
|
||||||
|
markdown, view the default documentation created. This file can be safely ignored if you don't
|
||||||
|
want to include a tutorial page.
|
||||||
|
|
||||||
|
### styles.css
|
||||||
|
This file is used when your repository is premium to display custom layouts for your viewers. It
|
||||||
|
can be safely ignored, or just as a place holder if the repo is not premium yet.
|
||||||
|
|
||||||
|
### reference/
|
||||||
|
This directory is used to hold the markdown files for the documentation/reference page. Every file
|
||||||
|
in this directory will be added as a section to the documentation with the section titled after
|
||||||
|
the file name, so make sure it's readable.
|
||||||
|
|
||||||
|
### guide/
|
||||||
|
This directory is used to hold the markdown files for the documentation/guide page. Every file in this
|
||||||
|
directory will be added as a section to the guide with the section titled after the file name, so
|
||||||
|
make sure it's readable.
|
Reference in New Issue
Block a user