Blog Support roadmap (Resolved)

[chuckdries]

Hello,

I'm excited to use vuepress for my personal website but I kinda want blog support before I switch, so I was thinking I'd kickstart that discussion on that now. This issue is to seek input as to what blog support might look like.

I was thinking a minimum viable product might be

• some kind of tag/category system
• An alternative default theme which feels more like a blog
• helper utilities for themes (high order components?) for getting lists of posts around the tag/category system
• Pre-defined markdown templates that correspond to theme vue components, like hexo's layouts
• A CLI command for bootstrapping posts, vuepress new [layout] <post title>

[FadySamirSadek]

I think you should add also the functionality to publish only posts with dates that has already came like gatsby and jekyll. If you need help I would absolutely love to work on these tasks with you

[gaomd]

• RSS/JSON Feed
• Draft post
• Ability to eliminates the .html extension
• Split date into subdirs: blog/2018-04-16-post-title.md => blog/2018/04/16/post-title/index.html

[mdaffin]

The ability to alias posts and create redirects for them to allow movement of old posts while preserving all incoming links.

[ch1nux]

Maybe list all post in some sort of filter (customizable, of course), tags or categories and show them in README.md at first (chronologically or by tags).

[Tsuki]

vuepress eject with default config

[lekevicius]

I have been reading VuePress code and comparing with the blog build system I have written for Gulp.

List of features I have for my gulp static blog:

• Markdown
• Custom frontmatter
• Per-post CSS and JS
• Content in siteData to create feed, index page, etc.
• RSS/JSON feed
• Date parsing from filename
• Tags in frontmatter
• Virtual directories in URL, as described by @gaomd, turning 2018-04-16-post-title.md to blog/2018/04/16/post-title/index.html
• Custom helper functions, like reading time calculation from markdown
• Pagination for blog page
• Paginated monthly archives
• Paginated tag pages
• Link-posts (like Daring Fireball, showing differently in feed if link frontmatter meta is found)

These are all the features I've built for gulp static site building, and would like VuePress to have.

However, adding all of that to the "core" would not be very great. I think a better, smarter solution would be to think of a way to allow themes to modify/plug into prepare and build stages, creating virtual pages, feed, etc.

I'm happy to help building and designing Blog theme, but I'd like to work out this build stage plugins before, instead of forking and modifying "core".

[mdaffin]

Looks like it is reasonably easy to get lists of posts and filter tags/categories working even without support in the Layouts. Inside any .md file:

---
home: true
---
<div v-for="post in posts_with_tag('some_tag')"
     :key="post.frontmatter.date">
  <router-link :to="post.path">
    <article>
      <div class="title">{{ post.title }}</div>
      <div class="date">{{ new Date(post.frontmatter.date).toLocaleDateString() }}</div>
      <div class="description">{{ post.frontmatter.description }}</div>
    </article>
  </router-link>
</div>

<script>
export default {
    methods: {
        posts_with_tag(tag) {
            return this.$site.pages
            .filter((page) => page.frontmatter.tags)
            .filter((page) => page.frontmatter.tags.includes(tag))
        },
        posts() {
            return this.$site.pages
            .filter((page) => page.path.startsWith("/blog/"))
        }
    },
}
</script>

The only missing part is being able to generate dynamic pages, but I think this can be solved generically along with creating a sitemap, rss feed, specific tag/category pages, redirect links by allowing the theme or pages to add extra routes with plain text content or layouts with data. With something like add_route(route, payload, layout) or add_route(route, content) that the layout/pages can call on the fly for example when they detect a new tag.

[lekevicius]

Quite right. Generic features/building blogs needed:

• Registering new routes in theme (for index, archives, tag pages, pagination)
• Content, not only metadata, in siteData (for feed, index, archive pages)
• URL rewriting for pages (transform .md filename to nice post URL)

With these building blogs, entire blogging system can be made 🎉

[mdaffin]

@lekevicius I think those are the core features that are missing from vuepress, once those are added I believe that the rest of the features listed in this thread can be accomplished through the default or may be an alternitive them. It might be worth rasing them as seperate issues if the others agree?

[GabMic]

A draft outosave system.

[yeedle]

What about comments? A default theme should perhaps offer a commenting component that integrates one of the popular commenting platforms.