Support for snippets that can be used in many pages #121
Replies: 5 comments 6 replies
-
I would like to upvote this issue. We have several user guides where certain procedures are repeated. An example of this is step by step details on how to connect a debugger tool to a circuit board and get the software working, but then the actual details of WHAT to program need to be individualized to the specific board. Being able to insert snippets that could be included in muliple gitbooks would be very much appreciated. It is our most bothersome issue at the moment. |
Beta Was this translation helpful? Give feedback.
-
Writing in to request this feature as well! Support for transclusions would be a game changer. Our API docs reference the steps to obtain and API and authenticate across multiple pages in our docs. At the moment I have opted to just linking directly to the header of the main authentication doc to save myself the maintenance headache of have to update the same section in 5 different pages. |
Beta Was this translation helpful? Give feedback.
-
surely. Without references, it would be difficult to keep your documentation consistent. This is an essential function for document-oriented services. |
Beta Was this translation helpful? Give feedback.
-
Hi everyone, a short update to let you know we're actively working on this and we should land something in the next few weeks. It'll be called "Synced blocks" |
Beta Was this translation helpful? Give feedback.
-
We just released Reusable content: https://github.com/orgs/GitbookIO/discussions/772 🎉 Let us know what you think in the announcement post. |
Beta Was this translation helpful? Give feedback.
-
What's your feature/idea?
Snippets (e.g. excerpts) would be pieces of content which are defined once, but can be inserted into any number of other articles. When those articles are published, the snippet content is included seamlessly. And if the snippet itself is updated, any articles referencing the snippet automatically pick up its updates.
Today, we have several articles which repeat the same content. Examples include: shared steps for a particular screen & introductory paragraphs. If I were to use GitBook, I'd have to manually repeat this content. And if I ever need to update that shared content, I must touch several articles (assuming I even remember which articles need these updates).
What's your desired outcome?
Here's an example of how snippets work within Notion, just to illustrate the effect of updating one location & having others reflect it:
In my case, I'd have several articles (like on the right) that would leverage the same shared content (left).
What's the impact of this for you?
Anything else?
This is the one feature that prevents us from adopting GitBook.
Beta Was this translation helpful? Give feedback.
All reactions