Global Landing Page

If you set up an Enterprise Group project, you can configure a global landing that your users can use to view and search across your individual projects.

Your group is a shell for your other projects. It contains no documentation pages itself, but does contain the global landing page.

Build Your Global Landing Page

To populate the global landing page, choose one of these approaches:

Design the page and create the source code.
Redirect to one of your existing project landing pages.
Redirect to any custom landing page that you serve yourself.

Global landing page code restrictions
If you create code to paste into the global landing page, all code must be contained in one file, and code is limited to HTML with embedded JavaScript and CSS. For greater flexibility, use the Redirect Instead field. In that case, you have to re-implement functionality such as the global search bar.

Configure Your Landing Page

Go to dash.readme.io/group/<YOUR_GROUP>/global-landing-page.
Choose one of the following:
- Copy and paste your source code into the Global Landing Page field.
- Add a link to the page you want to display in the Redirect Instead field.

Templating With Liquid

The global landing page supports a templating engine called Liquid to build out your HTML. With Liquid, you can access and iterate over projects and their categories and pages.

<div id="main" class="container">
  <div class="row">
    <div class="col-sm-5">
      <h1>{{parentProject.name}}</h1>
      <p>{{parentProject.description}}</p>
    </div>
    <div class="col-sm-7">
      <h4>Projects</h4>
      {% for child in parentProject.childrenProjects %}
        <div class="col-sm-6">
          <div class="project">
            <h4 class="child">{{child.name}}</h4>
            <div class="guides">
              {% for category in child.guides %}
                <h5 class="category">{{category.title}}</h5>
                <ul>
                  {% for page in category.pages %}
                  <li><a href="{{page.slug}}" class="page">{{page.title}}</a></li>
                  {% endfor %}
                </ul>
              {% endfor %}
            </div>
          </div>
        </div>
      {% endfor %}
    </div>

Available Properties

This syntax gives you access to the following properties: