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

[Feature] React Component to embed documentation snippets in app #4852

Open
joshknowles opened this issue Oct 11, 2024 · 0 comments
Open

[Feature] React Component to embed documentation snippets in app #4852

joshknowles opened this issue Oct 11, 2024 · 0 comments

Comments

@joshknowles
Copy link

Problem description

I want to be able to embed inline documentation throughout my application with links to the FernDoc page for extended details.

Currently I can do this via a custom React hover component with documentation copy-and-pasted between the app logic and the Fern docs, but it's easy for these to get out-of-sync.

Why would it be useful?

If Fern is going to become my central home for documentation, I want all of my documentation to live within Fern with multiple different ways to render it externally.

Describe the solution (optional)

React component that can be rendered within my application on hover or click that can display a short-snippet of documentation populated from Fern with a link to view the full summary on my Fern docs site. Screenshot below of the home-built solution that I would like to replace.

Additional context

CleanShot 2024-10-11 at 16 47 36

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant