diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 7a805a9..0000000 Binary files a/.DS_Store and /dev/null differ diff --git a/README.md b/README.md index 3791d27..c25d09d 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,89 @@ -# Fern Docs Starter Repo +
+
+ + header + + +
-```text -Start building beautiful documentation in under 5 minutes. -``` +# Fern Docs Starter -What this repo produces: [helloworld.docs.buildwithfern.com](https://helloworld.docs.buildwithfern.com) +Create beautiful documentation in under 5 minutes. Here's [an example!](https://helloworld.docs.buildwithfern.com) -![Hello World Docs](fern/docs/assets/helloworld.png) +[![Discord](https://img.shields.io/badge/Join%20Our%20Community-black?logo=discord)](https://discord.com/invite/JkkXumPzcG) -## Quick start +
-### Step 1: Fork this repo +--- -If needed, here are [instructions](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) +### Step 1: Use This Template -### Step 2: Clone your fork +1. Click on the "Use this template" button. +2. Create a new repository. Name it anything you like, `docs` is a common naming choice. -If needed, here are [instructions](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository) +### Step 2: Open in Your Preferred IDE -### Step 3: Generating "Hello World" docs +Clone your newly created repository and open it in your favorite integrated development environment (IDE) or code editor. -Install the Fern CLI by running: +### Step 3: Customize Organization Name -```bash -$ npm install -g fern-api +In the fern.config.json file, replace the placeholder organization name with your actual organization name. For example: + +```json +{ + "organization": "YourOrganization", + "version": "0.15.0" +} +``` + +Also, in the docs.yml file, update the docs URL to match your organization's naming convention. For example: + +```yml +instances: + - url: your-organization.docs.buildwithfern.com ``` -Now that the CLI is installed, generate docs: +### Step 4: Generate Your Documentation + +1. Install the Fern CLI by running: ```bash -$ fern generate --docs +npm install -g fern-api ``` -You'll be asked to login. Enter `y` which will walk you through connecting your GitHub account. +2. Generate your documentation with the following command: + +```bash +fern generate --docs +``` +You will be prompted to log in and connect your GitHub account. -When the docs are generated, Fern automatically publishes them to the domain configured in `docs.yml`. After successfully generating docs, you'll see: +Once the documentation is generated, you will receive a URL where your documentation is published. For example: ```text ┌─ -│ ✓ helloworld.docs.buildwithfern.com +│ ✓ your-organization.docs.buildwithfern.com └─ ``` -### Step 4: Customize your docs +### Step 5: Customize Your Documentation -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. +To get started, replace the provided OpenAPI specification with your own. Then, modify the markdown pages located in the [content](fern/docs/content/) directory. You can further tailor your documentation to match your brand by adjusting settings in the [docs.yml](fern/docs.yml) file. -### Step 5: 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: +### Step 6: Set Up a Custom Domain + +If you wish to use a custom domain like `docs.your-organization.com` or a subdirectory like `your-organization.com/docs`, you can subscribe to the [Starter plan](https://buildwithfern.com/pricing). Once subscribed, update [docs.yml](fern/docs.yml) with the custom domain configuration: ``` yaml - - url: {your-organization}.docs.buildwithfern.com - custom-domain: docs.{your-organization}.com + - url: your-organization.docs.buildwithfern.com + custom-domain: docs.your-organization.com ``` -### Step 6: You've advanced! -Looking to use **advanced features**? Head to the [Fern Docs Advanced Repo](https://github.com/fern-api/docs-advanced). +### Step 7: Explore Advanced Features + +For advanced documentation features and options, visit the [Fern Docs Advanced Repo](https://github.com/fern-api/docs-advanced). **Advanced features** include: - Versioning @@ -65,3 +91,5 @@ Looking to use **advanced features**? Head to the [Fern Docs Advanced Repo](http - Multiple APIs - Custom background - Bring your own fonts + +Good luck creating beautiful and functional documentation! 🌿 diff --git a/fern/.DS_Store b/fern/.DS_Store deleted file mode 100644 index ca2b787..0000000 Binary files a/fern/.DS_Store and /dev/null differ