This page lists steps to install and run the Portal.
Before installing the Redocly Portal, make sure to do the following:
yarn. These package managers work across all the major operating systems).
- Know how to run the commands from the CLI (for example,
yarn install). For Windows, we recommend using Git Bash.
- Know the basic git techniques (creating a branch, committing, and in our examples, opening a pull request on GitHub.)
- Get familiar with Markdown. We recommend using the Visual Studio Code application to manage your files.
- Clone the GitHub repository shared by Redocly.
git clone <url provided by Redocly>
- Install the project.
NOTE: If an error occurs during the installation, delete the
yarn.lock file, and then try to install Redocly Portal again.
If the installation problem persists, please contact the Redocly support.
You can now preview your files on the local server. The corresponding address will be displayed in the terminal.