gitbook-plugin-custom-landing v0.0.1

Gitbook Landing Page Plugin

This is a simple plugin that allows you to create a custom html page for your initial landing page for Gitbook.

I've only ever tested this using a local installation, don't pester me about using their paid hosting. I'm not sure if it'll work there.

To Use

Add the following plugin to your book.json config file:

  "plugins": [
    "custom-landing"
  ],

There are no config options for this plugin (yet).

You will still need to have a README.md file, don't bother filling anything in it however since it'll be overwritten by your index file. This may change in the future, I'm also open to pull requests on this.

Create a index.html file at the root of your documentation site. This file will be placed at the root of the output instead of what the README.md would create. You can do anything you want with that file! You will want to make sure you recreate things you setup (say favicon).

Lastly, this plugin will only affect the root README.md. It does not change any sub-folder README.md files.