Skip to content
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.

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

Update welcome.mdx #8

Merged
merged 6 commits into from
Dec 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
49 changes: 47 additions & 2 deletions fern/docs/pages/welcome.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Start building beautiful documentation in under 5 minutes.
</Callout>

### Hello World 👋
## Hello World 👋

Welcome to our documentation! Here you'll find information to get started as well as our API Reference.

Expand Down Expand Up @@ -40,6 +40,51 @@ Welcome to our documentation! Here you'll find information to get started as wel

To get started, customize the links, content, and theme to match your brand!

## SDKs

In addition to documentation, Fern can generate SDKs (client libraries) in popular programming languages. That way, you can offer users an experience such as:

<CodeBlocks>
<CodeBlock title="Node">
```bash
npm install your-organization
# or
yarn add your-organization
```
</CodeBlock>
<CodeBlock title="Python">
```bash
pip install your-organization
```
</CodeBlock>
<CodeBlock title="Go">
```bash
go get -u github.com/your-organization/go
```
</CodeBlock>
<CodeBlock title="Java">
```bash
<dependency>
<groupId>com.your-organization</groupId>
<artifactId>your-organization</artifactId>
<version>2.0.0</version>
</dependency>
# or
implementation("com.your-organization.java:sdk:2.0.0")
```
</CodeBlock>
<CodeBlock title="Ruby">
```bash
gem install your-organization
```
</CodeBlock>
<CodeBlock title="C#">
```bash
nuget install your-organization.net
```
</CodeBlock>
</CodeBlocks>

## Need help?

We have three channels to assist:
Expand All @@ -48,4 +93,4 @@ We have three channels to assist:

2. Open an issue on [GitHub](https://github.com/fern-api/docs-starter/issues/new) and we'll get back to you promptly.

3. Email us at [[email protected]](mailto:[email protected]) and we'll do our best to reply within 48 hours.
3. Email us at [[email protected]](mailto:[email protected]) and we'll do our best to reply within 48 hours.
4 changes: 2 additions & 2 deletions fern/fern.config.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"organization": "your-organization",
"version": "0.15.16"
}
"version": "0.16.3"
}
16 changes: 12 additions & 4 deletions fern/generators.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
# To run the code generator
# 1. `$ npm i -g fern-api`
# 2. `$ fern generate`
# To invoke the code generators
# 1. Install Fern: `npm i -g fern-api`
# 2. Run: `fern generate`

default-group: local
groups:
local:
generators:
# Generates an OpenAPI spec from your Fern Definition
- name: fernapi/fern-openapi
version: 0.0.28
config:
format: yaml
output:
location: local-file-system
path: ../openapi
path: ../generated/openapi

# Generates a Node.js client SDK from your Fern Definition
- name: fernapi/fern-typescript-node-sdk
version: 0.8.13
output:
location: local-file-system
path: ../generated/sdk/node
Loading