1. General Information
2. Installation
3. Add your APIs
4. Repository architecture

This repository is used as a template for the Talend API Portal based on HUGO.

Useful links:

• API Portal documentation
• HUGO documentation

1. Install Hugo.
2. Clone this repository.
3. Run Hugo:

# Start the server
hugo server

# Or start the server with building draft files
hugo server -D

4. Visit your API Portal on your browser.

There are 2 different ways to add APIs into the Portal:

1. By using API Designer. See documentation for more information.
2. By using the management API. See documentation for more information.

API Portal repository looks like this by default:

.
├── apis
│   └── _index.md
├── assets
│   └── css
│       └── 02_variables.css
├── CHANGELOG.md
├── config.toml
├── content
│   ├── getting-started.md
│   └── _index.md
├── NOTICE
├── README.md
├── static
│   └── img
│       └── brand-logo.png
└── themes
    └── ...

An overview of what each of these directories or files are using for: