Skip to content

Fix minor errors in readme #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix minor errors in readme #3

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e986c2
remove assets contents from folder index shown in readme as not relevant
minaelee Mar 3, 2024
53d6ab2
Merge branch 'fern-api:main' into add-initial-files
minaelee Mar 3, 2024
3fa894d
fix fern page index in readme
minaelee Mar 3, 2024
b06227d
fix errors in readme
minaelee Mar 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions README.md
View file
Open in desktop
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 All @@ -44,16 +45,13 @@ The `fern/` folder in your repository contains these files and folders:
├─ store.yml
└─ user.yml
├─ docs/
├─ assets/
├─ favicon.png
├─ logo_dark_mode.png
└─ logo_light_mode.png
└─ assets/
└─ pages/
├─ concepts.mdx
├─ sdks.mdx
└─ welcome.mdx
├─ docs.yml
├─ fern.config.json
└─ generators.yml
├─ docs.yml
└─ fern.config.json
```

The `definition/` folder contains Fern Definition files for a sample API called Swagger Petstore. Fern uses these files to generate the API Reference section of your docs site.
Expand Down Expand Up @@ -90,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 @@ -99,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 @@ -137,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