-
-
Notifications
You must be signed in to change notification settings - Fork 424
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
embed code fragments from external sources #205
Comments
Yeah but probably using a different syntax, like: <!-- embed foo.js as code block -->
#embed(/foo.js code language="js")
<!-- result: -->
```js
// content in foo.js
``` A fragment: #embed(/foo.md fragment)
<!-- result: -->
something to embed
Where # title
<!-- docute-embed-start -->
something to embed
<!-- docute-embed-end --> |
Sounds great! A couple more things 😛 is it possible to add support for:
For instance: <!-- embed example.js as code block -->
#embed(
https://raw.githubusercontent.com/someuser/somerepo/code/example.js
type=code
language="js"
fence="some-demo"
)
<!-- .../example.js -->
...
/// [some-demo-start]
...
/// [some-demo-end]
...
<!-- result -->
// some content from example.js within the /// [some-demo] and then <!-- import content from other .md file -->
#embed(
https://raw.githubusercontent.com/someuser/somerepo/example.md
type=fragment
fence="some-fragment"
)
<!-- .../exmaple.md -->
...
<!-- some-fragment-start -->
something to embed
<!-- some-fragment-end -->
... Being able to define the fence allows multiple partials from a single file to be imported. Externally loading code decouples the need for it to live alongside the documentation, say in an examples repo. |
The You can probably implement it as a plugin using this API: const embedPlugin = () => {
return {
name: 'embed',
extend(api) {
api.processMarkdown(async markdown => {
return modifiedMarkdown
})
}
}
}
new Docute({
plugins: [embedPlugin()]
}) |
Sweet, I'll give this a go soon! Cheers! |
@issuehunt has funded $100.00 to this issue.
|
Can i take this? |
@janat08 Feel free. I got caught up with life! |
@egoist please merge, its been half a year |
I would like to import fenced code from GitHub repo files similar to https://docsify.js.org/#/embed-files?id=embedded-code-fragments
Is this on the roadmap?
IssueHunt Summary
Sponsors (Total: $100.00)
Become a sponsor now!
Or submit a pull request to get the deposits!
Tips
The text was updated successfully, but these errors were encountered: