Markdown component

[ycmjason]

Hello,

I think it would be awesome if we could have a markdown vue component that could be used in the markdown pages.

This way we could module our very long markdown into smaller sections.

Thoughts?

E.g.

# My very long md

This is a freaking long md...

<vp-md src="./sectionA.md"/>

<vp-md src="./sectionB.md"/>

<vp-md src="./sectionC.md"/>

[yyx990803]

I don't think this has to be a component, can simply be a comment-based directive:

<!-- include ./sectionA.md -->

And then parsed and handled directly inside lib/webpack/markdownLoader.js.

[ycmjason]

I will look into that tonight if I got the time.

[ycmjason]

An attempt in here #227.

[MartinMuzatko]

There is already https://www.npmjs.com/package/markdown-it-include
But I see a few problems with this:

1. no vue templating within those included markdown files.
2. partials have to be excluded from getting rendered by vuepress

[ycmjason]

@MartinMuzatko my attempt at #227 should be able to load vue templating.

Yet, the partials are also being rendered. Maybe we could make it so that vuepress will ignore .partial.md files and not render them.

[eyleron]

How about the convention in other template languages or SCSS where filenames with a preceding underscore are treated as partials and don't get rendered?

_layout-header.md

[ycmjason]

@eyleron I am not so sure about this as @yyx990803 and @ulivz haven't got time to advice on this.

[davemacdo]

I know this is an old Issue, but it's something I would definitely use. I did want to point out that there are already several syntaxes for this in various markdown flavors. Personally, I'm used to using Mulitmarkdown's file transclusion syntax in a lot of my markdown already:

# Parent Markdown Stuff

{{path/to/included.md}}

See also:

• Brett Terpstra's multi-file document syntax, which has been adopted by other markdown processors
• iA Writer's Markdown Content Blocks

A lot of the content I'm including in VuePress sites exists as Markdown already, so the more it can mimic the behavior of other renderers, the better.

[ycmjason]

@davemacdo
Please see this: #227

There is a plan for rolling this out.

#421

In 1.0.0

[davemacdo]

Thanks. I missed that in my search. I'll take my comment there.