feat: udpating ve #931
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,83 @@ | ||
| --- | ||
| title: Fern Editor | ||
| description: Update your docs visually with a GitHub-backed workflow that creates PRs. | ||
| slug: /docs/content/fern-editor | ||
| --- | ||
|
|
||
| Fern Editor lets you modify your documentation without touching code. Make changes directly in your browser while maintaining your Git-based workflow. | ||
|
There was a problem hiding this comment.
Fern Editor brings a Notion-like editing experience to your documentation site. Write, edit, and publish directly in the browser—no need to open a code editor or learn markdown. The result is faster authoring, easier contributions for non-technical teammates, and a best-in-class visual editing experience powered by TipTap. |
||
|
|
||
| <Frame | ||
| caption="Edit your docs visually with Fern Editor" | ||
| background="subtle" | ||
| > | ||
| <img src="./visual-editor.png" /> | ||
| </Frame> | ||
|
|
||
| ## Try Fern Editor | ||
|
|
||
| <div className="action-buttons"> | ||
| <Button intent="primary" href="https://dashboard.buildwithfern.com/" rightIcon="arrow-right"> | ||
| Open Dashboard | ||
| </Button> | ||
| </div> | ||
|
|
||
| After logging in, connect your GitHub account. Then open Fern Editor from the Docs settings.it | ||
|
||
|
|
||
| ## Key Features | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="Easy to use" icon="duotone bolt"> | ||
| - Edit inline, use the slash (`/`) menu to add components | ||
| - Preview changes as you type - no local setup | ||
| - Works across your entire docs site | ||
| </Card> | ||
|
|
||
| <Card title="GitHub‑backed workflow" icon="fa-github"> | ||
| - Publishing creates a pull request with your changes | ||
| - Keep code review, CI checks, and branch protections | ||
| </Card> | ||
| </CardGroup> | ||
|
|
||
| All Fern components are supported. See the full list in the Components Overview: [Components Overview](https://buildwithfern.com/learn/docs/writing-content/components/overview). | ||
|
||
|
|
||
| ## Why Fern Editor | ||
|
|
||
| - Makes updating your docs site super simple | ||
|
||
| - GitHub-backed so you’ll always have a PR to review and merge | ||
|
|
||
| <Tip> | ||
| Have feedback? Use the Feedback button in the top-right of the editor. | ||
|
|
||
| </Tip> | ||
|
|
||
| ## FAQ | ||
|
|
||
| <AccordionGroup> | ||
| <Accordion title="How is “WYSIWYG” related to Fern Editor?"> | ||
|
There was a problem hiding this comment. would remove quotes from WYSIWYG and spell out the acronym There was a problem hiding this comment. could be the question: |
||
| “WYSIWYG” is a common term for visual editing. Fern Editor is our visual editor - same idea, clearer name. | ||
|
There was a problem hiding this comment. Can the answer just be "yes, Fern Editor is a WYSIWYG editor." |
||
| </Accordion> | ||
|
|
||
| <Accordion title="Why is a GitHub‑backed editor important?"> | ||
| Your changes become pull requests. That means code review, auditability, CI checks, and merge control with branch protections - no surprises in production. | ||
|
There was a problem hiding this comment. Would mention docs-as-code here. Would mention that docs-as-code makes consumption by AI tools easier. |
||
| </Accordion> | ||
|
|
||
| <Accordion title="Does Fern Editor support all components?"> | ||
| Yes. Fern Editor supports all built‑in components. See the full list here: [Components Overview](https://buildwithfern.com/learn/docs/writing-content/components/overview). | ||
| </Accordion> | ||
|
|
||
| <Accordion title="Can I use Fern Editor without local setup or CLI?"> | ||
| Yes. Edit directly in the browser - no local environment required. Your GitHub PR keeps your normal review and CI process. | ||
| </Accordion> | ||
|
|
||
| <Accordion title="How do I start using Fern Editor?"> | ||
| Log in to the [Dashboard](https://dashboard.buildwithfern.com/), connect GitHub, then open Fern Editor from the top navigation. | ||
| </Accordion> | ||
|
|
||
| <Accordion title="Is Fern Editor good for SEO and performance?"> | ||
|
There was a problem hiding this comment. Would remove. Don't think anyone will ask this question. |
||
| Yes. Pages are server‑rendered and optimized for SEO. Components within accordions and tabs are still indexable. | ||
| </Accordion> | ||
|
|
||
| <Accordion title="What browsers and devices does Fern Editor support?"> | ||
|
|
||
| Modern Chromium, Firefox, and Safari on desktop. Mobile editing is not yet supported. | ||
| </Accordion> | ||
| </AccordionGroup> | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you put slugs in
docs.ymlinstead of frontmatter for consistency?docs/fern/products/docs/docs.yml
Lines 65 to 68 in 1fd9ed7