It would be incredibly useful to be able to embed an entire Space into a website or a mobile app.
I still don't get why gitbook cli was removed. It offered static content generation, pdf generation...
That feature would be great for us too. We are working on a developer portal and have some documentation in Gitbook that we want to show/integrate. As far as I understand there is no viable solution as of now.
This would be the best feature ever. I believe it would be as simple as creating a vue, react, angular plugin which could interface with either the API or Github repository, and then its up to the users how to design the page. Also SEO wise this would be magnificent.
This is an early discussion. To be clear, we're not going to tackle this right now.
Here are the features that have been suggested:
- Embedding a GitBook documentation into a website.
- Offering a GitBook search widget to integrate into a contact form for example.
- Embedding a GitBook documentation into an app/software. Bonus point for offline capabilities.
@Nicolas: if you would ask me i would for sure go with embedding but search widget is also a great idea :-) i think embbed will work a lot better
@Nicolas: Why not turn GitBook into an headless service? This way the customers can integrate however they want to, public facing, private facing, in an app, website, etc.
@Nicolas it would be also great if there is an option to just embed a single page in a website for eg lets say i have a doc in the name of
my-opensourceproject and i also have a website for the same.
and i wrote all FAQ in Gitbook as of now if i need to show FAQ i have only 2 options
1. Duplicate the content
2. load full gitbook website in a iframe -- which take too much time
@Varun Sridharan: Of course duplicating content is not an option.
We're working on improving GitBook loading speed. But, even if GitBook loaded fast, having it in an iframe would be confusing as soon as you want to embed more than a single page. Having GitBook's navigation in an iframe inside your website with its own navigation would be hard to use.
The reason you want it on the same website is simply to share the same base domain my-opensourceproject ? If that's the goal, then allowing GitBook to live under my-opensourceproject/docs for example could be a better solution.
@Nicolas: I agree with you. lets say i have a open source project document hosted in Gitbook and i list my project somewhere in 3rd party website. and in that they have FAQ Section
Where i have 3 pages of FAQ in Gitbook i dont want to duplicate content again. instead i would like to embed it in that website
or lets say i run a wordpress website and i want make it easy for my project users to find the faq. so i want to show in my website itself without duplicating content.
Also i dont think it will get confusing if we have a more than 1 iframe since most users now use Visual Editor like Gitbook dose. :-)
A chat widget would also be super cool
@Ben Gubler: A GitBook widget makes sense. We won't explore this direction for now though, as we have more important matters, but it's something we want to address at some point.
It would be really nice to have offline pages generated that we could have installed with our software so users could view the docs without internet.
@Ben Gubler: At this point, it takes a developer to integrate GitBook's content, and depending on how far you want to go, it could be hard for GitBook to offer something that just work.
Because of that, I don't think we will ever offer this out of the box. What we can imagine instead, is that GitBook exposes a machine friendly format for your content (JSON) that you will be able to display as you wish in your software.
@Raphael Mimoun also shared a similar idea. It's interesting, but it would take a lot of work to provide something easy to use and integrate in any mobile app for example.
So when I say that we won't ever do it, it's more that, with the current size of our team, we are not capable of offering this :)
This could change in the future.
- embed into a website, so that users don't need to access yet another resource externally
- more importantly, embed into our mobile app so users can access it without leaving it, and ideally offline (it would either update in the background when the user is in the app, or be updated in each new version of the app)
This is definitely a feature we are thinking about. We still need to examine the possible use cases. We like the idea of integrating GitBook to a "Help" widget for example. Users could search for answers before contacting the website owners.
Sharing your needs and use-cases is welcome!
Nice house. I'm taking note, thank you :)
@Nicolas: Hi! We have an ERP program with an integrated help. Program it´s Chromium based and it was fully operational a few months ago, but now it seems not working perfectly. Scroll not appear, search not work at all...
I hope this feature could help and we are available to help using our app:
Thanks and waiting for good news...
P.D.: I wrote to support and we were talking about this problem (Gabin)
@Nicolas: About this feature. Our use case is the following: We have some (private) content that we want only logged users in our website to see.
Would this feature be suitable for our goal? If that is not the case, Do you see any way of doing this?
@Nicolas: This would be great feature. I have a website app that I want to have a searchable API link where without having to leave my site, users can access my gitbook documentation. An iframe would be great, but also some kind of widget would be awesome too!