Build and deploy beautiful documentation sites that grow with you

Build and deploy beautiful documentation sites that grow with you

OrchidGitlab

Connect your site to GitLab services.

official wiki publication

About

OrchidGitlab connects Orchid to Gitlab's services, including integrating wikis and publishing your site directly to Gitlab Pages.

Demo

Usage

Wiki Adapter

OrchidGitlab comes with a gitlab Wiki Adapter, to integrate a project wiki as an Orchid wiki section. This will clone the wiki repository and convert its contents to an Orchid wiki automatically. If a _Sidebar file exists in the wiki, pages will be ordered according to the order of links in that sidebar file. Otherwise, pages will be ordered alphabetically, with a summary page generated listing all pages in order.

# config.yml
wiki: 
  sections:
    userManual:
      adapter: 
        type: "gitlab"
        repo: "[username/repo]" # the wiki attached to this project will be used

Gitlab Pages Publisher

The gitlabPages publisher will take your rendered site and publish it to a static website on Gitlab Pages. You must have a personal access token set for publication to work, see Configuration below.

# config.yml
services:
  publications:
    stages:
      - type: 'gitlabPages'
        username: '[username]' # the username which created the personal access token
        repo: '[username/repo]' # the repo to publish to

Configuration

You must generate a personal access token from Gitlab to successfully authenticate and allow Orchid to perform actions on your behalf, like publishing a site to Gitlab Pages. This can be set as the gitlabToken environment variable, or passed to Orchid from Gradle.

// build.gradle
orchid {
    gitlabToken = project.property("gitlabToken")
}

Note that this token grants full access to your account, and should be treated like any normal password. Never check it in to your repository.

dependencies {
    orchidRuntime("io.github.javaeden.orchid:OrchidGitlab:0.18.0")
}
<dependency>
    <groupId>io.github.javaeden.orchid</groupId>
    <artifactId>OrchidGitlab</artifactId>
    <version>0.18.0</version>
    <type>pom</type>
</dependency>
@file:DependsOn("io.github.javaeden.orchid:OrchidGitlab:0.18.0")