Skip to content

Latest commit

 

History

History
390 lines (301 loc) · 9.09 KB

README.md

File metadata and controls

390 lines (301 loc) · 9.09 KB
Raw

Blog template with NextJS

한국어

Version requirements

Node.js: 16.13.0 Yarn: 1.22.18

Features

1. Markdown/MDX Articles

You can write a articles with Markdown/MDX in Blog, Resume and Projects.

2. Reading time

This project can parse Markdown/MDX articles and convert to reading time from words and display it.

3. Dynamic OG Image (SSR Only)

This feature is available in SSR only.

This project can generate OG Images dynamically. If you want to use dynamic og image, add a useDyanmicThumbnail prop and remove image in HeadMeta Component` like this.

import HeadMeta from "~/components/HeadMeta";

const Page = () => {
  return (
    <>
      <HeadMeta
        title="foo"
        description="foo description"
        useDyanmicThumbnail={true} // Change here.
      />
      {/* Content Here... */}
    </>
  );
};

4. Simple deploy options

You can choose depoly types from SSR/SSG if you want build this project to SSG, you can build simple to type yarn static than deploy it from out folder. And you can build this project to SSR to type yarn build.

5. Routes object generator

You can generate route object dynamically in starting dev sever or build this project. If you start a dev server or build this project, a routes.ts is will generate in _generated folder and routes.ts is looks like this (with formatting).

const routes = [
  { path: "/", name: "Blog" },
  { path: "/projects", name: "Projects" },
  { path: "/resume", name: "Resume" },
];

export default routes;

You can routes.ts file as object in any components like components/header/index.tsx.

// ...
import routes from "~/_generated/routes";

const Header = () => {
  return (
    // ...
    <NavList className="flex-col md:flex-row">
      {routes.map((route: Route) => {
        return (
          <NavItem href={route.path} pathname={pathname} key={route.name}>
            {route.name}
          </NavItem>
        );
      })}
    </NavList>
    // ...
  );
};

export default Header;

If you want ignore Routes in route.ts at scripts/routes.ts and change getPages Function like this.

// ...
pipe(
  getPages(["pages/api/*", "pages/_*", "pages/index.*"]), // ignore lists.
  generateRouteContent("blog"),
  writeFile("_generated/routes.ts")
);
// ...

6. i18n Locale (New! / SSR Only for now)

This feature is SSR only now. but I'll convert or create a repo to for SSG soon. If you want see more infos about next-i18next, Click here

If you follow this steps, you can add locale in your blog. (yay!)

How to add

  1. Add locale files in public/locales/[language] like this.
📦public
 ┣ etc...
 ┣ 📂locales
 ┃ ┣ 📂en-US
 ┃ ┃ ┣ 📜common.json
 ┃ ┃ ┣ 📜projects.json
 ┃ ┃ ┗ 📜resume.json
 ┃ ┗ 📂ko
 ┃ ┃ ┣ 📜common.json
 ┃ ┃ ┣ 📜projects.json
 ┃ ┃ ┗ 📜resume.json
 ┗ etc...
  1. Write a locale text like this. (You have to create a common.json for default locale file.)
  • Static locale text
{
  "title": "Welcome to test's page."
}
  • Locale text with variable
{
  "title": "Welcome to {{username}}'s page."
}
  1. Apply locales to page.
  • Without variables
const Index = ({ articles }: Props) => {
  const { t } = useTranslation("common"); // locale filename

  return (
    <div>
      // t("locale key in file")
      <h1>{t("title")}</h1>
    </div>
  );
};

// A locale infos are already pass from here.
export const getStaticProps = async ({ locale }: GetStaticPropsContext) => {
  return {
    props: {
      // Other props...
      // A locale is returns undefined sometimes.
      // But if you use locale in pages, you can get locale without undefined.
      ...(await serverSideTranslations(locale as string, ["common"])), // locale filename
    },
  };
};

export default Index;
  • With variables
const Index = ({ articles }: Props) => {
  const { t } = useTranslation("common"); // locale filename

  return (
    <div>
      // t("locale key in file", { variableKey: value })
      <h1>{t("title", { username: "foo" })}</h1>
    </div>
  );
};

// A locale infos are already pass from here.
export const getStaticProps = async ({ locale }: GetStaticPropsContext) => {
  return {
    props: {
      // Other props...
      // A locale is returns undefined sometimes.
      // But if you use locale in pages, you can get locale without undefined.
      ...(await serverSideTranslations(locale as string, ["common"])), // locale filename
    },
  };
};

export default Index;

Remove a locale feature.

If you want to remove a locale features, just follow a steps.

  1. Remove a Article data in _data folder other locale and save a articles of default locale. (In this case, a default locale is Korean. And you can see default locale in next-i18next.config.js)
  2. Remove a locales file in public.
  3. Remove a modules from next-i18next like useTranslation or serverSideTranslations in page files.

Quick Start

1. Clone this repo

git clone https://github.com/ForestLee0513/blog-with-nextjs.git

2. Install packages

This template is optimized to Yarn, but you can use npm too.

yarn

3. Start development server

yarn dev
# open localhost:3000

4. Edit your bio

Open bio.ts file in root and change it if you're clone this repo successfully, this file will display like this.

const bio = {
  username: "Username",
  description: "hello world",
  url: "https://username.github.io",
  link: {
    Github: "https://github.com/username",
  },
};

export default bio;

5. Write your things

All Markdown files are includes in _data folder. Check a frontmatter of each pages and apply it.

You can write a articles with markdown or MDX and you can import a component of /components folder in MDX files.

  1. Blog

    ---
title: "Blog article"
description: "A example of blog article"
date: 2022-10-27 16:25:00
---
...

    You can write a blog articles with Markdown or MDX in _data/blog folder. If you create a file correctlly, you'll get this results like this: Blog index Blog article

  2. Resume

    ---
title: "Doe's reusme"
date: 2022-10-27 16:25:00
description: "I have a 2 years of Front-end job experiences."
---
...

    You can write a resume with Markdown or MDX in _data/resume.md file. If you edit a file correctlly, you'll get this result like this:

    Resume

  3. Proejcts

    ---
title: "Personal ACME Project"
description: "A simple website"
date: 2022-10-27 16:25:00
---
...

    You can write a resume with Markdown or MDX in _data/projects folder. If you edit a file correctlly, you'll get this results like this:

    Projects index Projects article

6. Deploy it!

A root url should change to your deploy URL for display dynamic og image. You can change root url in url at bio.ts and config.url at package.json

Deploy to Netlify Deploy with Vercel

Customize

Change styles

This template is use tailwindcss.
you can change style in /styles folder.

Change dyamic OG Image styles

You can change dynamic OG Image styles in pages/api/og.tsx

// ...

const OgImageHandler = async (req: NextRequest) => {
  const spoqaRegularData = await spoqaRegular;
  const spoqaBoldData = await spoqaBold;

  const { searchParams } = new URL(req.url);

  const hasTitle = searchParams.has("title");
  const hasDescription = searchParams.has("title");
  const title = hasTitle
    ? searchParams.get("title")?.slice(0, 100)
    : `${bio.username}'s Page`;
  const description = hasDescription
    ? searchParams.get("description")?.slice(0, 100)
    : `${bio.description}`;

  return new ImageResponse(
    (
      <div
        style={{
          display: "flex",
          flexDirection: "column",
          justifyContent: "center",
          alignItems: "center",
          background: "white",
          width: "100%",
          height: "100%",
          padding: "30px",
          fontFamily: "Spoqa Han Sans Neo",
        }}
      >
        <h1
          style={{
            fontSize: 48,
            fontWeight: 600,
          }}
        >
          {title}
        </h1>
        <p style={{ fontWeight: 400 }}>{description}</p>
      </div>
    ),
    {
      width: 1200,
      height: 630,
      fonts: [
        {
          name: "Spoqa Han Sans Neo",
          data: spoqaRegularData,
          weight: 400,
          style: "normal",
        },
        {
          name: "Spoqa Han Sans Neo",
          data: spoqaBoldData,
          weight: 600,
          style: "normal",
        },
      ],
    }
  );
};