Shortcode for including remote markdown files #1739
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
froboy
suggested changes
Jun 11, 2024
There was a problem hiding this comment.
@fekete-robert this is fan-flipping-tastic! I ran into one feature request that I've added here. Take a look.
| {{ end }} | ||
|
|
||
| {{/* Output stuff after the frontmatter if a frontmatter was detected. */}} | ||
| {{- index $split 2 | markdownify | safeHTML -}} |
There was a problem hiding this comment.
Suggested change
| {{- index $split 2 | markdownify | safeHTML -}} | |
| {{- delimit (last 1 $split) "" | markdownify | safeHTML -}} |
I have some GitHub README's that have H1s (#) instead of frontmatter. I want to be able to trim those H1s from my pages. This small change will allow us to use the trim parameter to trim H1s too. 🎊
| The `include-remote-md` shortcode fetches a remote markdown file and includes it in the page. This happens only when your Docsy project is built, so future changes of the remote markdown file are only included when you rebuild your project. | ||
|
|
||
| If the file has a frontmatter, define the marker of the frontmatter in the second parameter of the shortcode (defaults to `---`). Note that if the content after the frontmatter includes the marker (for example, includes `---` as part of a markdown-formatted table) the content is truncated. | ||
|
|
There was a problem hiding this comment.
Suggested change
| If the file has a H1 (`# ....`) instead of frontmatter, you can put the title line in as the second parameter and it will be removed instead. For example: | |
| ```go-html-template | |
| {{</* include-remote-md "https://raw.githubusercontent.com/google/docsy/main/README.md" "# Docsy" */>}} | |
| \``` |
(The leading \ on the end of the code fence will need to be removed because I'm not sure how to put a fence in a suggestion without breaking it)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1716