A docsify.js plugin to embed selective areas from another markdown file.
npm install docsify-betterembedA docsify.js plugin to embed selective areas from another markdown file.
How to install this plugin.
For production, please use the numbered version to prevent breaking changes in production.
`` html`
If you are developing on a doc, you can use the latest. Make sure you switch it to production later, or the production one right away.
` html`
> [!NOTE]
> Sorry for not providing a demo, but I thought this is a very self explanatory setup. But I am using this activly in another projects.
1. Surround the part you want to embed in the following comment:
` markdown
YOUR CONTENT HERE
`
> [!IMPORTANT]
> Make sure you respect the spaces between the comments and your content. It can mess with the html (specifically tables), if they are left out.
2. Embed the content like this:
` markdown`
Some Name
--> The link will then be replaced with the content.
If it doesn't the selector, it will embed the whole page. Aka, you might have done something wrong.
- Setup 2 just converts to a different text, you can also use this to keep the link for Markdown, vanilla-feeling:
` markdown`
Some Name
- Because the selector is what decides the beginning and the end, you can nest and overlay the embed selections, however you like it.
` markdown
Very original stuff.
Oh, So much content
uhm.. hows your day?
``
I'm always happy, if someone has improvements to this little plugin. If you want to help, anything goes, but preferred is what is on the roadmap below or maybe discuss it as a GitHub issue first. ^^
Nothing much here, but I'm planning to add the following features at some point:
- [ ] Support for docsify-mustache so Docsify can have proper templating.
- [ ] Being able to use header as a selector and not use comments to mark the start and end.
- [ ] Offset header levels to either fit the current layout, or being able to select it.
This repo is using the MIT license.
Thanks to the docsify.js team to make writing plugins so simple. I usually don't front end, but this was a breeze to get working.