Joining the Hub

To include your library documentation in Workleap's Frontend Platform Hub, follow these steps.

Create your Retype website

First, navigate to the Retype getting started guide to set up a Retype website within your library repository.

Basic setup

Then, open the retype.yml file located at the root of the repository and copy/paste the following basic configuration:

retype.yml
# -------------------
# Retype
# -------------------

input: ./docs
output: .retype

url: [THE GITHUB PAGES URL OF YOUR SITE]

branding:
    title: [THE NAME OF YOUR LIBRARY]
    logo: ./static/logo.png

edit:
    repo: [YOUR REPOSITORY]
    base: /docs
    branch: main

footer:
    copyright: "© Copyright {{ year }} - Workleap"

# To allow using {{ }} in code blocks.
# View: https://github.com/retypeapp/retype/issues/622#issuecomment-1712391219.
templating:
    enabled: false

showSidebarFilter: false

verbose: true

Finally, add the following script to your package.json file:

package.json
{
    "dev-docs": "retype start"
}

Try it 🚀

Start your new Retype site by executing the dev-docs script.

Adhere to Workleap's conventions

The following conventions are optional but highly recommend to to guarantee a consistent and unified experience for Workleap's developers within the Workleap Frontend Platform hub.

Icons

First, add Workleap's reversed bleu logo and favicon to the /docs/static folder:

root
├── docs
├──── static
├────── logo.png
├────── favicon.png

Then, configure Retype to use the new assets by including the following configurations to your retype.yml file:

retype.yml
# -------------------
# Retype
# -------------------
branding:
    logo: ./static/logo.png

favicon: ./static/favicon.png

Then, add the following links to the top nav bar of your Retype site:

Link Description
Home A link to the homepage of your Retype site.
Found a bug A link to your library's bug tracker.
Feature requests A link to request a new feature for your library.
Releases A link to a page listing your library releases.
GitHub (or another platform) A link to your library's repository.
NPM / Nugget A link to the library's packages.

Your Retype links configuration should closely resemble the following configurations

Then, add the following links to the footer of your Retype site:

Link Description
About A link to an about page including meta informations about your library project (example).
License A link to the license of your library.

Your Retype footer links configuration should closely resemble the following configurations

Retype navigation section/page items

When appropriate, we recommend adding the following section/page item to the main navigation (on the left):

Item Example
Introduction section https://workleap.github.io/wl-squide/introduction
Guides section https://workleap.github.io/wl-squide/guides
Reference section https://workleap.github.io/wl-squide/reference
Troubleshooting page https://workleap.github.io/wl-squide/troubleshooting
Samples page https://workleap.github.io/wl-squide/samples

Include the shared CSS customizations file

Our Retype websites share a CSS file that contains several customizations to enhance the default Retype style. To incorporate this file into your Retype site, follow these steps:

Create the _includes/head.html file

Create a _includes/head.html file within the /docs folder:

root
├── docs
├──── _includes
├────── head.html

Then, open the newly created _includes/head.html file and copy/paste the following content:

_includes/head.html
<link href="https://workleap.github.io/wl-idp-docs-hub/static/retype-customization.css" rel="stylesheet" />

Activate pro features

Workleap has acquired an Enterprise license for Retype, which you can locate the key in our secure Vault. To enable Retype's pro features, copy and paste the following configuration into your retype.yml file:

retype.yml
# -------------------
# Retype Pro
# -------------------

poweredByRetype: false

outbound:
    enabled: true
    icon: ""

breadcrumb:
    enabled: true
    home: false

toc:
    depth: 2

hub:
    link: https://workleap.github.io/wl-idp-docs-hub/
    alt: Workleap's Frontend Platform homepage

nav:
    mode: stack
    icons:
        mode: none

theme:
    base:
        nav-badge-margin-left: 0.75rem

start:
    pro: true

Configure your Retype wallet

Since we've added the following lines to your retype.yml file:

retype.yml
start:
    pro: true

You can now develop a Retype site locally with the pro features without the need for a local Retype wallet. However, if you prefer to set up your local Retype wallet, follow these steps:

  1. Locate the Retype license key in our secure Vault.
  2. Utilize the Retype CLI to create your wallet.

Host your site on GitHub pages

To use our Retype enterprise license, and for every hub features of Retype to work properly, the site must be hosted on the https://workleap.github.io domain. As this is a GitHub Pages domain, to join the hub, your Retype site must be deployed with GitHub Pages.

To configure your Retype site to be deployed with GitHub Pages, refer to the following guide.

Add your site to the hub

Send a PR to the wl-idp-docs-hub GitHub repository to add your site to the hub. Once merged, your site will be automatically added to the Workleap Frontend Platform hub!

© Copyright 2026 - Workleap