From 09965696a7b219298cb25a72991482c5ca19faf7 Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 11:42:50 -0400 Subject: [PATCH 01/13] Delete .DS_Store --- .DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 .DS_Store diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 7a805a9784726296d7f3e4af2c486cc37e0ba220..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeH~O=`nH427RsLj&Dp+2x#|&>IXPJwY!}()15P18uYSF4xYJMk!N_w_TJc&^%is zdGNQeEC9ATZ0~?2fCb$ZM_;Dq`|cCF$jBwt{2AM?r`=}1-%T>-1717e7O!~6cVB;X z4&n_5Z2GMMFL=f$KKkJN5!w*}5fA|p5CIYB2(V|nEv}nt6#)?tfgb|?eJFI-nmRU( zPY0J60jLARVZ4r6f?7O4t*K*EMrhVbsjbv<#IRP*c*(q)IyP`K(0>26P>`hyG|G%ft%>SMv69EzUrvz+RKde`Lx$Lcz*YsXn=#TWXF*nk= lL@TC7E9Q;2;+rn7_%-)y>ew{O8IN+RegvG0Oa%UdzzI*49ryqM From 7504a77044ce95a17e79137d0b351f8f0cee742c Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 11:43:01 -0400 Subject: [PATCH 02/13] Delete fern/.DS_Store --- fern/.DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 fern/.DS_Store diff --git a/fern/.DS_Store b/fern/.DS_Store deleted file mode 100644 index ca2b7874ee44cef1857d5487e8c8184223131c55..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeH~F$w}f3`G;&La^D=avBfd4F=H@>;(h`8(BfodXDZ-CJ2t!BJu;tpJXO1`-+{7 zi0JxuSc&u^GJ~7S(n4d3ypw~RWiQwJa2ZeM@rat$Cvn!+@Lrnz*rt#G36KB@kN^q% z5COZlVY7KvMiL+a5_l4@??Zx{=Fn2rKOG1@0zf;I-LUpq0-CG<&7q|#Dlm=dL8DcD z46(YmLsOi~p`~hV7meXV4M3`}dgXhH(h?7~0-B+w9;*1Wg-e+&OK|2Hj6Nq_|Y zjDU8VVY9|d#ohY$dRE^>)z$?L_2URHKLJSWDqg_du%B!J&7q|#Dlq;CI0gn1_$q-1 D?w=C8 From 11ef8c0234895c5ba3c8c65abe84fc66c1073aeb Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 15:38:27 -0400 Subject: [PATCH 03/13] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3791d27..4f46eb2 100644 --- a/README.md +++ b/README.md @@ -23,13 +23,13 @@ If needed, here are [instructions](https://docs.github.com/en/get-started/quicks Install the Fern CLI by running: ```bash -$ npm install -g fern-api +npm install -g fern-api ``` Now that the CLI is installed, generate docs: ```bash -$ fern generate --docs +fern generate --docs ``` You'll be asked to login. Enter `y` which will walk you through connecting your GitHub account. From d12ca9da19cd7663026a261fdb7199ada4608a9a Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 15:39:29 -0400 Subject: [PATCH 04/13] Update README.md --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4f46eb2..7aff0fd 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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: @@ -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: From ed86adcffeea4c587ecb8c220fcdad965bb87590 Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 23:00:02 -0400 Subject: [PATCH 05/13] Update README.md --- README.md | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7aff0fd..0067cf3 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,33 @@ What this repo produces: [helloworld.docs.buildwithfern.com](https://helloworld. ## Quick start -### Step 1: Use this template. +### Step 1: Use this template -### Step 2: Generating "Hello World" docs +Select "Use this template" and then "Create a new repository." Choose the appropriate organization and then name the repo. It is common to name the repo `docs`. + +### Step 2: Open in VS Code + +Or your IDE of choice. + +### Step 3: Add your organization name + +In the file `fern.config.json` change the **organization name**. For example: + +```json +{ + "organization": "HelloWorld", + "version": "0.15.0" +} +``` + +In the file `docs.yml` change the **docs url**. For example: + +```yml +instances: + - url: helloworld.docs.buildwithfern.com +``` + +### Step 4: Generate your docs Install the Fern CLI by running: @@ -20,16 +44,16 @@ Install the Fern CLI by running: npm install -g fern-api ``` -Now that the CLI is installed, generate docs: +Generate docs: ```bash fern generate --docs ``` -You'll be asked to login. Enter `y` which will walk you through connecting your GitHub account. +You'll be asked to login 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 docs are generated, you'll see the URL your docs published to. For example: ```text ┌─ From bfb7f17eb731356829cb998e1768253e433ebddb Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 23:01:20 -0400 Subject: [PATCH 06/13] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 0067cf3..67c7f3e 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ Start building beautiful documentation in under 5 minutes. What this repo produces: [helloworld.docs.buildwithfern.com](https://helloworld.docs.buildwithfern.com) -![Hello World Docs](fern/docs/assets/helloworld.png) - ## Quick start ### Step 1: Use this template From 49fe4c1f57b5df8d84cc26bc77939c882be7a447 Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 23:01:46 -0400 Subject: [PATCH 07/13] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 67c7f3e..ebe2b46 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Fern Docs Starter Repo +# Quickstart ```text Start building beautiful documentation in under 5 minutes. @@ -6,8 +6,6 @@ Start building beautiful documentation in under 5 minutes. What this repo produces: [helloworld.docs.buildwithfern.com](https://helloworld.docs.buildwithfern.com) -## Quick start - ### Step 1: Use this template Select "Use this template" and then "Create a new repository." Choose the appropriate organization and then name the repo. It is common to name the repo `docs`. From b7dd9e85933b0039daff94dca93562e164e29a3a Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 23:07:40 -0400 Subject: [PATCH 08/13] Update README.md --- README.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ebe2b46..327ba1d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,28 @@ +
+
+ + header + + +
+ # Quickstart +[![Contributors](https://img.shields.io/github/contributors/fern-api/starter-docs.svg)](https://GitHub.com/dotnet/docs/graphs/contributors/) +[![Pulls-opened](https://img.shields.io/github/issues-pr/fern-api/starter-docs.svg)](https://GitHub.com/starter-docs/docs/pulls?q=is%3Aissue+is%3Aopened) +[![Pulls-merged](https://img.shields.io/github/issues-search/fern-api/starter-docs?label=merged%20pull%20requests&query=is%3Apr%20is%3Aclosed%20is%3Amerged&color=darkviolet)](https://github.com/starter-docs/docs/pulls?q=is%3Apr+is%3Aclosed+is%3Amerged) + +[![Discord](https://img.shields.io/badge/Join%20Our%20Community-black?logo=discord)](https://discord.com/invite/JkkXumPzcG) + +
+ ```text Start building beautiful documentation in under 5 minutes. ``` -What this repo produces: [helloworld.docs.buildwithfern.com](https://helloworld.docs.buildwithfern.com) +**See the Docs this repo generates** -> [https://helloworld.docs.buildwithfern.com](https://helloworld.docs.buildwithfern.com) + +--- ### Step 1: Use this template @@ -57,11 +75,11 @@ Once the docs are generated, you'll see the URL your docs published to. For exam └─ ``` -### Step 3: Customize your docs +### Step 5: 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 4: Setup a custom domain +### Step 6: 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: @@ -70,7 +88,7 @@ To set up a subdomain like `docs.your-website.com` or a subdirectory like `your- custom-domain: docs.{your-organization}.com ``` -### Step 5: You've advanced! +### Step 7: 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: From 3f6c428344f9dd35c5b8ba9ef680fbe3f9132d6d Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 23:17:52 -0400 Subject: [PATCH 09/13] Update README.md --- README.md | 64 +++++++++++++++++++++++++++---------------------------- 1 file changed, 31 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 327ba1d..2b5d6af 100644 --- a/README.md +++ b/README.md @@ -6,90 +6,86 @@
-# Quickstart +# Fern Docs Starter -[![Contributors](https://img.shields.io/github/contributors/fern-api/starter-docs.svg)](https://GitHub.com/dotnet/docs/graphs/contributors/) -[![Pulls-opened](https://img.shields.io/github/issues-pr/fern-api/starter-docs.svg)](https://GitHub.com/starter-docs/docs/pulls?q=is%3Aissue+is%3Aopened) -[![Pulls-merged](https://img.shields.io/github/issues-search/fern-api/starter-docs?label=merged%20pull%20requests&query=is%3Apr%20is%3Aclosed%20is%3Amerged&color=darkviolet)](https://github.com/starter-docs/docs/pulls?q=is%3Apr+is%3Aclosed+is%3Amerged) +Welcome to the Fern Docs Quickstart, your one-stop solution for building beautiful and user-friendly documentation for your API. With Fern, you can create beautiful documentation in under 5 minutes. [![Discord](https://img.shields.io/badge/Join%20Our%20Community-black?logo=discord)](https://discord.com/invite/JkkXumPzcG) -```text -Start building beautiful documentation in under 5 minutes. -``` - -**See the Docs this repo generates** -> [https://helloworld.docs.buildwithfern.com](https://helloworld.docs.buildwithfern.com) +Docs published from this Starter repo: [https://helloworld.docs.buildwithfern.com](https://helloworld.docs.buildwithfern.com) --- -### Step 1: Use this template +### Step 1: Use This Template -Select "Use this template" and then "Create a new repository." Choose the appropriate organization and then name the repo. It is common to name the repo `docs`. +1. Click on the "Use this template" button. +2. Create a new repository. Name it anything you like, `docs` is a common naming choice. -### Step 2: Open in VS Code +### Step 2: Open in Your Preferred IDE -Or your IDE of choice. +Clone your newly created repository and open it in your favorite integrated development environment (IDE) or code editor. -### Step 3: Add your organization name +### Step 3: Customize Organization Name -In the file `fern.config.json` change the **organization name**. For example: +In the fern.config.json file, replace the placeholder organization name with your actual organization name. For example: ```json { - "organization": "HelloWorld", + "organization": "YourOrganization", "version": "0.15.0" } ``` -In the file `docs.yml` change the **docs url**. For example: +Also, in the docs.yml file, update the docs URL to match your organization's naming convention. For example: ```yml instances: - - url: helloworld.docs.buildwithfern.com + - url: your-organization.docs.buildwithfern.com ``` -### Step 4: Generate your docs +### Step 4: Generate Your Documentation -Install the Fern CLI by running: +1. Install the Fern CLI by running: ```bash npm install -g fern-api ``` -Generate docs: +2. Generate your documentation with the following command: ```bash fern generate --docs ``` -You'll be asked to login and connect your GitHub account. - +You will be prompted to log in and connect your GitHub account. -Once the docs are generated, you'll see the URL your docs published to. For example: +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 5: 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 6: 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 7: 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 @@ -97,3 +93,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! 🌿 From a11246d3124dff13e647f062a17a4d2fbd468905 Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 23:18:55 -0400 Subject: [PATCH 10/13] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2b5d6af..740a6d2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
- header + header
From ce981569c6fb77e3b59fe533f231f230bfcf8f19 Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 23:28:08 -0400 Subject: [PATCH 11/13] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 740a6d2..3fa47ec 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ # Fern Docs Starter -Welcome to the Fern Docs Quickstart, your one-stop solution for building beautiful and user-friendly documentation for your API. With Fern, you can create beautiful documentation in under 5 minutes. +Create beautiful documentation in under 5 minutes. [![Discord](https://img.shields.io/badge/Join%20Our%20Community-black?logo=discord)](https://discord.com/invite/JkkXumPzcG) From 5b74e1857df317ec4ddffac3a90b8909fe5f2b7a Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 23:30:25 -0400 Subject: [PATCH 12/13] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3fa47ec..96d427d 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,9 @@ Create beautiful documentation in under 5 minutes. [![Discord](https://img.shields.io/badge/Join%20Our%20Community-black?logo=discord)](https://discord.com/invite/JkkXumPzcG) -
+Example of Fern Docs: [https://helloworld.docs.buildwithfern.com](https://helloworld.docs.buildwithfern.com) -Docs published from this Starter repo: [https://helloworld.docs.buildwithfern.com](https://helloworld.docs.buildwithfern.com) + --- From d412acf245ffea763d05433c2bfad78c503eb739 Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Mon, 2 Oct 2023 23:31:15 -0400 Subject: [PATCH 13/13] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 96d427d..c25d09d 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,10 @@ # Fern Docs Starter -Create beautiful documentation in under 5 minutes. +Create beautiful documentation in under 5 minutes. Here's [an example!](https://helloworld.docs.buildwithfern.com) [![Discord](https://img.shields.io/badge/Join%20Our%20Community-black?logo=discord)](https://discord.com/invite/JkkXumPzcG) -Example of Fern Docs: [https://helloworld.docs.buildwithfern.com](https://helloworld.docs.buildwithfern.com) - ---