Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Create your landing page

a great way to welcome your visitors and provide clear directions.

A landing page is the first page that a visitor of your website will see. Hence, you want to make sure it has the right vibe and contains the right information. As in books, the cover can be set differently than its content.

In Jupyter Book you have the option to:

Hide outline and table of contents

To use the full width of the page, you can hide the outline and table of contents by including the following in your index.md (if that is the landing page):

---
site:
  hide_outline: true
  hide_toc: true
  hide_title_block: true
---

As we make use of the page-last-updated plugin, we also set no-update-date: true to hide the date of the last update.

Create specific blocks

You can create specific blocks which are styled differently. For instance, we used split-image at the top of the page. And justified for the section on hiding the outline and table of contents.

To create a split image on your landing page, you can use the split-image directive. This allows you to have an image on one side and text on the other side. You can customize the content and layout to fit your needs, e.g. include a button that links to some other page or website.


+++ { "kind": "split-image" }

# Create your landing page

a great way to welcome your visitors and provide clear directions.

{button}`Check out the full documentation <https://mystmd.org>`

![](../figures/delft.png)

+++

In a similar we used the justified block which creates a block that spans the full width of the screen:

+++ {"kind": "justified"}

Cards

Often cards are used at the landing page to link to specific pages or websites. For instance, using the justified:

Gallery of landing pages

Below is a selection of landing pages created by the Jupyter Book community. You can use these for inspiration when creating your own landing page.