Skip to content

Commit

Permalink
fix errors in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
minaelee committed Mar 3, 2024
1 parent 3fa894d commit b06227d
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Here's [an example.](https://docs.propexo.com/documentation)

- Node 18 or higher
- A [GitHub](https://github.com) account
- Familiarity with using a CLI

---

Expand Down Expand Up @@ -87,7 +88,6 @@ Install the Fern CLI tool globally by running:
npm install -g fern-api
```

When prompted, log into and connect your GitHub account.

> [!NOTE]
> The above CLI command is a global command that you can run from any location. The `fern` commands in the following steps must be run from within your repository.
Expand All @@ -96,10 +96,12 @@ When prompted, log into and connect your GitHub account.

Run the following command:

```bash
```shell
fern generate --docs
```

When prompted, log into and connect your GitHub account.

Once the documentation is generated, Fern displays the URL where you can view the published documentation. For example:

```shell
Expand Down Expand Up @@ -134,11 +136,11 @@ To learn about Fern's built-in component library you can use in Markdown:

### Step 7: Set up a custom domain

If you wish to use a custom subdomain like `https://docs.YOUR_ORGANIZATION.com` or a subpath like `https://YOUR_ORGANIZATION.com/docs`, you can subscribe to the [Starter plan](https://buildwithfern.com/pricing). Once subscribed, update `docs.yml` with the custom domain configuration, replacing YOUR_ORGANIZATION with your own.
If you wish to use a custom subdomain like `https://docs.YOUR_ORGANIZATION.COM` or a subpath like `https://YOUR_ORGANIZATION.COM/docs`, you can subscribe to the [Starter plan](https://buildwithfern.com/pricing). Once subscribed, update `docs.yml` with the custom domain configuration, replacing YOUR_ORGANIZATION with your own:

```yaml
- url: YOUR_ORGANIZATION.docs.buildwithfern.com
custom-domain: docs.YOUR_ORGANIZATION.com
custom-domain: docs.YOUR_ORGANIZATION.COM
```

Good luck creating beautiful and functional documentation! 🌿
Expand Down

0 comments on commit b06227d

Please sign in to comment.