# Joining the hub

To include your library documentation in Workleap's IDP hub, follow these steps.

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

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

# -------------------
# 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

verbose: true

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

{
    "dev-docs": "retype start"
}

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

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

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
# -------------------
branding:
    logo: ./static/logo.png

favicon: ./static/favicon.png

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

Your Retype links configuration should closely resemble the following configurations

# -------------------
# Retype
# -------------------
links:
    - text: Home
      icon: home
      link: /

    - text: Found a bug?
      icon: issue-opened
      link: [YOUR LINK]
      target: blank

    - text: Feature requests
      icon: comment-discussion
      link: [YOUR LINK]
      target: blank

    - text: Releases
      icon: tag
      link: [YOUR LINK]
      target: blank

    - text: Github
      icon: mark-github
      link: [YOUR LINK]
      target: blank

    - text: NPM
      icon: <svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0 0H24V24H0V0Z" fill="#CC0000"/><path d="M11.9184 2.57758H2.57764V21.4214H11.9175V7.32958H16.6695V21.4214H21.4215V2.57758H11.9184Z" fill="white"/></svg>
      link: [YOUR LINK]
      target: blank

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

Your Retype footer links configuration should closely resemble the following configurations

# -------------------
# Retype
# -------------------
footer:
    links:
        - text: About
          icon: question
          link: [YOUR LINK]

        - text: License
          icon: shield-check
          link: [YOUR LINK]
          target: blank

We recommend adding an icon before each folder item of the main navigation (on the left):

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 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:

<link href="https://gsoft-inc.github.io/wl-idp-docs-hub/static/retype-customization.css" rel="stylesheet" />

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 Pro
# -------------------

poweredByRetype: false

outbound:
    enabled: true
    icon: ""

breadcrumb:
    enabled: true
    home: false

toc:
    depth: 2

hub:
    link: https://gsoft-inc.github.io/wl-idp-docs-hub/
    alt: Workleap's IDP homepage

start:
    pro: true

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

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.

To use our Retype enterprise license, and for every hub features of Retype to work properly, the site must be hosted on the https://gsoft-inc.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.

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 IDP hub!