Skip to content
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

Add recent blog posts on homepage #37

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ const config = {
description: 'An open-source framework for building practical distributed replication mechanisms.',
gitHubUrl: gitHubUrl,
siteLicense: siteLicense,
recentBlogPostsOnHomePage: 5
},

// GitHub pages deployment config.
Expand All @@ -49,6 +50,21 @@ const config = {

clientModules: ['/js/unscrambleEmail.js'],

plugins:[
[
'./plugins/blog-plugin',
{
blogTitle: 'Replica_IO Blog',
blogDescription: 'Blog of the Replica_IO project - an open-source framework for building practical distributed replication mechanisms.',
showReadingTime: true,
showLastUpdateTime: true,
showLastUpdateAuthor: true,
// Remove this to remove the "edit this page" links.
editUrl: `${siteGitHubUrl}/edit/main/`,
},
]
],

presets: [
[
'classic',
Expand All @@ -59,15 +75,7 @@ const config = {
// Remove this to remove the "edit this page" links.
editUrl: `${siteGitHubUrl}/edit/main/`,
},
blog: {
blogTitle: 'Replica_IO Blog',
blogDescription: 'Blog of the Replica_IO project - an open-source framework for building practical distributed replication mechanisms.',
showReadingTime: true,
showLastUpdateTime: true,
showLastUpdateAuthor: true,
// Remove this to remove the "edit this page" links.
editUrl: `${siteGitHubUrl}/edit/main/`,
},
blog: false,
theme: {
customCss: ['./src/css/custom.css'],
},
Expand Down
33 changes: 33 additions & 0 deletions plugins/blog-plugin.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { shouldBeListed } from '@docusaurus/plugin-content-blog/src/blogUtils';
const blogPluginExports = require('@docusaurus/plugin-content-blog');

const defaultBlogPlugin = blogPluginExports.default;

async function blogPluginExtended(...pluginArgs) {
const blogPluginInstance = await defaultBlogPlugin(...pluginArgs);

return {
// Add all properties of the default blog plugin so existing functionality is preserved
...blogPluginInstance,

/**
* Override the default `contentLoaded` hook to access blog posts data
*/
contentLoaded: async function (params) {
const { content, actions } = params;

const posts = content.blogPosts
.filter(shouldBeListed)
.map(({ content: _, ...post }) => post);
actions.createData('blog-posts-metadata.json', posts);

// Call the default overridden `contentLoaded` implementation
return blogPluginInstance.contentLoaded(params);
},
};
}

module.exports = {
...blogPluginExports,
default: blogPluginExtended,
};
27 changes: 27 additions & 0 deletions src/components/RecentBlogPost/index.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import React from 'react';

const RecentBlogPost = ({ post }) => {
const { metadata } = post;
const formattedDate = new Date(metadata.date).toLocaleDateString('en-US', {
year: 'numeric',
month: 'long',
day: 'numeric',
});
const readingTime = Math.round(metadata.readingTime);

return (
<a href={metadata.permalink} className="card" style={{ textDecoration: 'none', color: 'inherit' }}>
<div className="card__header">
<h3>{metadata.title}</h3>
</div>
<div className="card__body">
<p>{metadata.description}</p>
</div>
<div className="card__footer">
<p>{formattedDate} · {readingTime} min read</p>
</div>
</a>
);
};

export default RecentBlogPost;
24 changes: 24 additions & 0 deletions src/components/RecentBlogPosts/index.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import React from 'react';
import posts from '@site/.docusaurus/docusaurus-plugin-content-blog/default/blog-posts-metadata.json';
import RecentBlogPost from '../RecentBlogPost';

const RecentBlogPosts = ({ nrPosts }) => {
const recentPosts = posts.slice(0, nrPosts);

if (recentPosts.length === 0) {
return null;
}

return (
<div>
<h1>Recent Blog Posts</h1>
<div className="card__wrapper" style={{ display: 'grid', gap: '1rem' }}>
{recentPosts.map((post, index) => (
<RecentBlogPost key={index} post={post} />
))}
</div>
</div>
);
};

export default RecentBlogPosts;
7 changes: 7 additions & 0 deletions src/pages/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import clsx from 'clsx';

import Heading from '@theme/Heading';
import styles from './index.module.css';
import RecentBlogPosts from '../components/RecentBlogPosts';


function HomepageHeader() {
const { siteConfig } = useDocusaurusContext();
Expand Down Expand Up @@ -39,6 +41,8 @@ export default function Home() {

useBrokenLinks().collectAnchor('#contact-email');

const nrRecentBlogPosts = siteConfig.customFields.recentBlogPostsOnHomePage;

return (
<Layout
description={siteConfig.customFields.description}>
Expand Down Expand Up @@ -115,6 +119,9 @@ export default function Home() {
</p>
</p>
</p>
<div className="container padding-vert--xl">
<RecentBlogPosts nrPosts={nrRecentBlogPosts} />
</div>
</main>
</Layout>
);
Expand Down