-
Notifications
You must be signed in to change notification settings - Fork 911
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: Ability to easily embed markdown docs NOT iframe #1716
Comments
You can try to use something like this shortcode: Invocation:
Shortcode (
I made it for one of my projects for a similar usecase, it doesn't do much, but might be enough for you. |
Alternatively, if you want to include files only from one or two repos, you can add them to your project as dependencies, mount the content of the repos somewhere, and include the files using readfile. |
Thanks for the quick response @fekete-robert! I think the e.g.
|
Try this, it will handle the frontmatter, with some limitations:
Also, I forgot to mention that if the file you want to include contains shortcodes, you have to invoke the include-remote-snippet shortcode with |
That works, thank you! I can live without the table use case for now.👍 A further enhancement to the If you want to consider this for being included in Docsy, then perhaps you can keep this issue open. If not, then feel free to close this issue out. |
Glad that it works :) I'll think about how to get only a specific section, but honestly I don't see an easy way to do that. |
Sounds good! I would say something like looking for a specific header code like |
Hey folks, I've been working on this and have cleaned up a few issues flagged in the original PR. Check it out. #1739 (review) I think my changes might be able to resolve some of what @dtzar was asking... I'm using it to trim a H1 from a README file that doesn't have a Markdown frontmatter, like this:
|
I'm trying to find a way to embed GitHub markdown content with Hugo/Docsy like what works today with mdbook as seen here for the Cluster API project (source) and website render of that page.
All that I can find is being able to use iframe with Docsy, which does not work since GitHub does not allow embed and likely will not produce desired behavior (feel/functionality). You can see this example deployed here (and equivalent source code).
It's important I figure out a pattern which will work for not only the karpenter project, but also the CAPI project. The ideal goal would be to have a core shared set of documentation and then embedded documentation for each of the providers. Would really like to migrate CAPI* to Hugo/Docsy as this seems to be the standard and offers nicer functionality, but this is a blocker now for both projects (karpenter Azure website would be new).
The text was updated successfully, but these errors were encountered: