Jekyll LibDoc as remote theme

Steps to follow to use quickly Jekyll LibDoc without tricky installation

Jekyll LibDoc as remote theme on GitHub

This repository contains only the configuration and the content of Jekyll LibDoc theme since version 1.0.1.

Available only on GitHub, remote theme feature is the most simple way to use LibDoc, it does not require any installation, just follow these few steps:

  1. Create a repository
    Just add a new repository on your GitHub account, this directory is an example.
  2. Create a LibDoc config file
    Create and configure your LibDoc config file called _config.yml, required for GitHub Pages, do not forget to add/uncomment the following line:
    remote_theme: olivier3lanc/Jekyll-LibDoc
    View a _config.yml example
  3. Enable Github Pages
    To automatically compile your LibDoc project, just enable GitHub Pages at https://github.com/[GH_USER_NAME]/[REPO_NAME]/settings/pages. Each time you commit and push on the specified branch, Github Pages builds and hosts your project on the URL https://[GH_USER_NAME].github.io/[REPO_NAME].

Your repository is now ready to be deployed as GitHub Pages website, all you have to do is adding your content! Learn more about remote themes.