Added support for git-doc

This commit is contained in:
counterpoint
2014-10-15 14:45:10 +01:00
parent 4acd85cf82
commit b35b269b37
7 changed files with 123 additions and 0 deletions

View 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.

View 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.