@docusaurus/plugin-content-blog

What is @docusaurus/plugin-content-blog?

@docusaurus/plugin-content-blog is a plugin for Docusaurus, a static site generator. This plugin allows you to create and manage a blog within your Docusaurus site. It provides features like blog post creation, pagination, tags, and more.

What are @docusaurus/plugin-content-blog's main functionalities?

Create Blog Posts

This feature allows you to create and manage blog posts in Markdown or MDX format. The configuration specifies the path to the blog directory, the route base path, and other settings like the blog title and description.

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-content-blog',
      {
        path: './blog',
        routeBasePath: '/blog',
        include: ['*.md', '*.mdx'],
        blogTitle: 'My Blog',
        blogDescription: 'A Docusaurus powered blog!',
      },
    ],
  ],
};

Pagination

This feature enables pagination for your blog posts. You can specify the number of posts per page using the `postsPerPage` option.

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-content-blog',
      {
        path: './blog',
        routeBasePath: '/blog',
        postsPerPage: 10,
      },
    ],
  ],
};

Tags

This feature allows you to categorize your blog posts using tags. The configuration can also include options to show reading time and customize the blog sidebar.

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-content-blog',
      {
        path: './blog',
        routeBasePath: '/blog',
        showReadingTime: true,
        blogSidebarCount: 'ALL',
        blogSidebarTitle: 'All posts',
      },
    ],
  ],
};

Other packages similar to @docusaurus/plugin-content-blog

hexo

Hexo is a fast, simple, and powerful blog framework. It provides a wide range of features for creating and managing blogs, including support for Markdown, extensive theming options, and plugins for additional functionalities. Unlike @docusaurus/plugin-content-blog, Hexo is a standalone framework rather than a plugin for a static site generator.

jekyll

Jekyll is a static site generator focused on blogging. It offers features like Markdown support, templates, and plugins. Jekyll is highly customizable and is often used for GitHub Pages. While it provides similar blogging functionalities, it is a standalone tool rather than a plugin for another static site generator like @docusaurus/plugin-content-blog.

README

The README file is missing

Changelog

2.0.0-alpha.40 (2019-12-25)

:rocket: New Feature

• docusaurus-theme-classic
  • #2117 feat(v2): auto switch theme depending on the system theme (@lex111)
  • #2055 feat(v2): hide navbar on scroll (@lex111)

:bug: Bug Fix

• docusaurus
  • #2145 fix(v2): remove style-loader, use minicssextract in both dev & prod (@endiliey)
  • #2122 fix(v2): dont collapse whitespace in minified html (@endiliey)
• docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs
  • #2105 fix(v2): move metadata export after compiling MDX to avoid weird MDX parsing error. (@endiliey)
• docusaurus-theme-classic
  • #2113 fix(v2): set stored theme only if it exists (@lex111)

:nail_care: Polish

• docusaurus-theme-classic
  • #2129 fix(v2): disable scroll while mobile menu open (@lex111)
• docusaurus-theme-classic, docusaurus
  • #2127 refactor(v2): toggle data-theme with vanilla js instead of react helmet (@endiliey)
• docusaurus-theme-search-algolia, docusaurus
  • #2125 feat(v2): lazy load algolia css so its not render blocking (@endiliey)

:memo: Documentation

• Other
  • #2135 docs(v1): add space between "out" and "Docusaurus" (@TransmissionsDev)
  • #2128 docs(v1): showcase user Shrine (@janko)
  • #2110 docs(v2): fix pages routing inaccurate info (@endiliey)
  • #2106 fix(v2): add missing hyphen in color generator (@lex111)
  • #2104 feat(v2): add color generator for primary colors (@yangshun)
  • #2103 docs: mention about moving docs directory into website (@yangshun)
• docusaurus-theme-classic, docusaurus-theme-live-codeblock
  • #2114 fix(v2): add syntax highlight to generated colors (@lex111)

:house: Internal

• Other
  • #2126 docs: promote Docusaurus 2 usage (@yangshun)
  • #2119 fix(v2): align GH button in vertical center (@lex111)
• docusaurus-init
  • #2124 feat(v2): add Facebook Docusaurus 2 template (@yangshun)
• docusaurus
  • #2111 feat(v2): explicit babel/runtime version (@endiliey)
• docusaurus-1.x, docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-theme-live-codeblock, docusaurus
  • #2102 misc: add command to run prettier on docs (@yangshun)

:running_woman: Performance

• docusaurus
  • #2118 perf(v2): reduce HTML payload by eliminating chunk-map (@endiliey)
  • #2116 feat(v2): minify html (@endiliey)

Committers: 6

• Alexey Pyltsyn (@lex111)
• Endi (@endiliey)
• Janko Marohnić (@janko)
• Nick McCurdy (@nickmccurdy)
• Yangshun Tay (@yangshun)
• t11s (@TransmissionsDev)