Custom front page

# Adding a custom front page to your docs

It's always nice to have a page explaining your project before inviting users to view your documentation.

At Gendocs, we do exactly the same thing with our home page at gendocs.io

This front page is a pure html file, you are completely free to style it however you want.

You will also need to provide a link to the remainder of your documentation.

# Create your front page

Create a single html file in your documentation directory.

It does not matter what you call it or which extension it has.

# Register it in your config

In your config file assign the name of your html file under the key "frontPage".

json
{
  "frontPage": "index.html"
}

# Publish

After publishing your docs you will now have a front page designed completely to your wishes.