Skip to content

Latest commit

 

History

History
107 lines (80 loc) · 3.24 KB

README.md

File metadata and controls

107 lines (80 loc) · 3.24 KB

Redocly landing page gallery

Welcome to Redocly's Landing Page Gallery! In addition to Markdown pages, the following Redocly products allow you to build custom pages with React: Realm, Revel, and Reef.

This repository contains a collection of example landing pages built using React and related tooling. The examples are designed to help you learn how to create custom React pages in your documentation.

Example pages

The gallery has the following example pages available:

Screenshot Description
Example SaaS landing page thumbnail

Example SaaS landing page

A sleek, modern landing page for a SaaS product. Features a full-width hero with CTA, highlighted features, full-width quote, pricing plans, and email subscription.

Tools: React, styled-components

View source code

Training portal landing page thumbnail

Redocly training portal landing page

An example landing page built for training and onboarding. Features hero with gradient background and responsive content cards with icons.

Tools: React, styled-components

View source code

Table of contents

Usage

Follow these steps to run the development server and preview the landing pages:

  1. Clone the repo:

    git clone https://github.com/Redocly/landing-page-gallery.git
  2. Navigate to the project folder.

  3. Start the development server: npx @redocly/cli@latest preview

  4. Click the Preview URL in the console to open project in browser.

Project structure

Each landing page is self-contained in its own folder, including any components or resources needed for that page.

Dependencies are managed from the central package.json file.

Contributing

Contributions to the Landing page gallery are quite welcome. Follow these steps if you'd like to add a new example or improve an existing one:

  1. Fork the repo

  2. Create new branch for your changes

  3. Make your changes and follow the project structure

  4. Submit a pull request with description of your changes or additions

  5. If adding a new page, add thumbnail and description to README.md

Requests

We'd like to expand the gallery with new and useful examples. If there's a specific page or React-based tool you'd like an example of, please open an issue using our issue template.

We'll review issues and consider adding them in the future.