From 4267c28d7ef99a9eef3b69dc7ec10f404878ad4e Mon Sep 17 00:00:00 2001 From: Andrew Jiang Date: Sun, 24 Nov 2024 20:10:57 -0500 Subject: [PATCH 1/3] snippet templates example --- fern/docs.yml | 7 +++++++ fern/docs/pages/snippet-templates.mdx | 13 +++++++++++++ fern/docs/snippets/code-snippet.mdx | 3 +++ fern/fern.config.json | 2 +- fern/generators.yml | 2 ++ 5 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 fern/docs/pages/snippet-templates.mdx create mode 100644 fern/docs/snippets/code-snippet.mdx create mode 100644 fern/generators.yml diff --git a/fern/docs.yml b/fern/docs.yml index 03757f7..3fc9b25 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -23,6 +23,9 @@ navigation: - page: SDKs path: docs/pages/sdks.mdx slug: sdks + - page: Snippet Templates + path: docs/pages/snippet-templates.mdx + hidden: true - api: API Reference navbar-links: @@ -45,3 +48,7 @@ logo: href: https://buildwithfern.com/?utm_campaign=demo&utm_medium=plantstore&utm_source=logo favicon: docs/assets/favicon.svg + +experimental: + mdx-components: + - ./docs/snippets diff --git a/fern/docs/pages/snippet-templates.mdx b/fern/docs/pages/snippet-templates.mdx new file mode 100644 index 0000000..54ec27b --- /dev/null +++ b/fern/docs/pages/snippet-templates.mdx @@ -0,0 +1,13 @@ +import CodeSnippet from "../snippets/code-snippet.mdx"; + + + ```python + print("Example 1") + ``` + + + + ```python + print("Example 2") + ``` + diff --git a/fern/docs/snippets/code-snippet.mdx b/fern/docs/snippets/code-snippet.mdx new file mode 100644 index 0000000..216fa97 --- /dev/null +++ b/fern/docs/snippets/code-snippet.mdx @@ -0,0 +1,3 @@ +## {props.title} + +{props.children} \ No newline at end of file diff --git a/fern/fern.config.json b/fern/fern.config.json index 26d1b83..2c0bf5b 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "plantstore", - "version": "0.37.6" + "version": "0.45.0" } \ No newline at end of file diff --git a/fern/generators.yml b/fern/generators.yml new file mode 100644 index 0000000..5406252 --- /dev/null +++ b/fern/generators.yml @@ -0,0 +1,2 @@ +api: + path: openapi/openapi.yaml From 8e53f68202a15a0e9a49a261b6db0ddda5ca227b Mon Sep 17 00:00:00 2001 From: Andrew Jiang Date: Sun, 24 Nov 2024 20:15:15 -0500 Subject: [PATCH 2/3] update test --- fern/docs/pages/snippet-templates.mdx | 12 +++++++----- fern/docs/snippets/code-snippet.mdx | 3 --- fern/docs/snippets/code-template.mdx | 5 +++++ 3 files changed, 12 insertions(+), 8 deletions(-) delete mode 100644 fern/docs/snippets/code-snippet.mdx create mode 100644 fern/docs/snippets/code-template.mdx diff --git a/fern/docs/pages/snippet-templates.mdx b/fern/docs/pages/snippet-templates.mdx index 54ec27b..3265fc8 100644 --- a/fern/docs/pages/snippet-templates.mdx +++ b/fern/docs/pages/snippet-templates.mdx @@ -1,13 +1,15 @@ -import CodeSnippet from "../snippets/code-snippet.mdx"; +import Template from "../snippets/code-template.mdx"; - +Below are 2 code snippets that are templated using the `code-template` mdx-based component. + + - + diff --git a/fern/docs/snippets/code-snippet.mdx b/fern/docs/snippets/code-snippet.mdx deleted file mode 100644 index 216fa97..0000000 --- a/fern/docs/snippets/code-snippet.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## {props.title} - -{props.children} \ No newline at end of file diff --git a/fern/docs/snippets/code-template.mdx b/fern/docs/snippets/code-template.mdx new file mode 100644 index 0000000..f1d555f --- /dev/null +++ b/fern/docs/snippets/code-template.mdx @@ -0,0 +1,5 @@ +This is a templated code snippet for {props.title}. + + +{props.children} + \ No newline at end of file From 19b9f26398434627c9d1c36d5e2b23484ec5dcf5 Mon Sep 17 00:00:00 2001 From: Andrew Jiang Date: Sun, 24 Nov 2024 20:17:47 -0500 Subject: [PATCH 3/3] reduce complexity of the example --- fern/docs/snippets/code-template.mdx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/fern/docs/snippets/code-template.mdx b/fern/docs/snippets/code-template.mdx index f1d555f..94a4559 100644 --- a/fern/docs/snippets/code-template.mdx +++ b/fern/docs/snippets/code-template.mdx @@ -1,5 +1,3 @@ -This is a templated code snippet for {props.title}. +This is a templated code snippet for {props.title}: - {props.children} - \ No newline at end of file