Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dannysheridan authored Oct 2, 2023
1 parent dd9b96e commit d12ca9d
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,9 @@ What this repo produces: [helloworld.docs.buildwithfern.com](https://helloworld.

## Quick start

### Step 1: Fork this repo
### Step 1: Use this template.

If needed, here are [instructions](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)

### Step 2: Clone your fork

If needed, here are [instructions](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)

### Step 3: Generating "Hello World" docs
### Step 2: Generating "Hello World" docs

Install the Fern CLI by running:

Expand All @@ -43,11 +37,11 @@ When the docs are generated, Fern automatically publishes them to the domain con
└─
```

### Step 4: Customize your docs
### Step 3: Customize your docs

To start, swap the OpenAPI spec for your own. Then revise the markdown pages in the [content](fern/docs/content/) directory. You'll find additional configurations in [docs.yml](fern/docs.yml) that allow you to tailor your docs to fit your brand.

### Step 5: Setup a custom domain
### Step 4: Setup a custom domain

To set up a subdomain like `docs.your-website.com` or a subdirectory like `your-website.com/docs`, subscribe to the Fern [Starter plan](https://buildwithfern.com/pricing). Once subscribed, update your `docs.yml` to add:

Expand All @@ -56,7 +50,7 @@ To set up a subdomain like `docs.your-website.com` or a subdirectory like `your-
custom-domain: docs.{your-organization}.com
```
### Step 6: You've advanced!
### Step 5: You've advanced!
Looking to use **advanced features**? Head to the [Fern Docs Advanced Repo](https://github.com/fern-api/docs-advanced).
**Advanced features** include:
Expand Down

0 comments on commit d12ca9d

Please sign in to comment.