Version: 2.0.0-beta.4

블로그

초기 설정#

여러분의 사이트에 블로그를 설정하고 싶다면 먼저 blog 디렉터리를 만들어주어야 합니다.

그리고 docusaurus.config.js 파일에 블로그 연결을 위한 아이템 링크를 추가해줍니다.

docusaurus.config.js

module.exports = {  themeConfig: {    // ...    navbar: {      items: [        // ...        {to: 'blog', label: 'Blog', position: 'left'}, // or position: 'right'      ],    },  },};

새로운 글 추가하기#

블로그에 새로운 글을 추가하기 위해서는 blog 디렉터리 안에 YYYY-MM-DD-my-blog-post-title.md 형식으로 파일을 만들어주어야 합니다. 글 작성일은 파일명에서 가져옵니다.

예를 들어 my-website/blog/2019-09-05-hello-docusaurus-v2.md 라는 파일을 아래와 같은 내용으로 작성합니다.

---title: Welcome Docusaurus v2author: Joel Marceyauthor_title: Co-creator of Docusaurus 1author_url: https://github.com/JoelMarceyauthor_image_url: https://graph.facebook.com/611217057/picture/?height=200&width=200tags: [hello, docusaurus-v2]description: This is my first post on Docusaurus 2.image: https://i.imgur.com/mErPwqL.pnghide_table_of_contents: false---Welcome to this blog. This blog is created with [**Docusaurus 2**](https://docusaurus.io/).
<!--truncate-->
This is my first post on Docusaurus 2.
A whole bunch of exploration to follow.

헤더 옵션#

title만 필수 항목입니다. 하지만 아래 항목을 설정해 글쓴이에 대한 추가적인 정보를 제공할 수 있습니다.

author: 화면에 표시되는 글쓴이 이름을 설정합니다.
author_url: 글쓴이 이름에 링크로 연결될 URL을 설정합니다. 깃허브나 트위터, 페이스북 프로필 등을 연결할 수 있습니다.
author_image_url: 글쓴이의 프로필 사진 이미지 URL을 설정합니다.
author_title: 글쓴이에 대한 간단한 설명을 추가합니다.
title: 블로그 포스트 제목을 설정합니다.
slug: 블로그 포스트 url을 변경할 수 있도록 허용합니다(/<routeBasePath>/<slug>). 여러 패턴을 설정할 수도 있습니다: slug: my-blog-post, slug: /my/path/to/blog/post, slug: /.
date: 블로그 포스트를 작성한 날짜를 설정합니다. 값을 설정하지 않으면 파일명에서 자동으로 추출합니다. 예를 들면 2021-04-15-blog-post.mdx 파일에서 날짜를 추출합니다. 기본값은 마크다운 파일을 만든 시간입니다.
tags: 포스트를 태그하기 위한 문자열 또는 오브젝트의 목록입니다. label과 permalink 2개의 필드로 구성됩니다.
draft: 아직 게시글을 작성하고 있다면 공개 여부를 설정해서 외부에 보이지 않도록 합니다. 비공개 설정 게시물도 개발 서버에서는 확인할 수 있습니다.
description: 게시글에 대한 간단한 요약입니다. 설정한 요약문은 <head> 태그 안에 <meta name="description" content="..."/>, <meta property="og:description" content="..."/> 형식으로 변환되며 검색 엔진에서 사용하게 됩니다. 값을 설정하지 않으면 기본값으로 콘텐츠의 첫 번째 줄을 사용합니다.
keywords: <head> 태그 내에 <meta name="keywords" content="keyword1,keyword2,..."/> 형태로 생성되는 키워드 메타 태그를 설정합니다. 검색 엔진에서 사용합니다.
image: 게시글에 대한 링크를 표시할 때 보여지는 커버 또는 섬네일 이미지를 설정합니다.
hide_table_of_contents: 오른쪽에 표시되는 목차 숨김 여부를 설정합니다. 기본값은 false입니다.

요약문만 먼저 보여주기#

게시물 작성 시  마커를 사용하면 게시물이 보여질 때 요약문이 먼저 표시됩니다.  위에 작성된 내용이 요약문이 됩니다. 예를 들면 아래와 같은 형식입니다.

---title: Truncation Example---All these will be part of the blog post summary.
Even this.
<!--truncate-->
But anything from here on down will not be.
Not this.
Or this.

피드#

feedOptions 설정을 전달해 RSS/Atom 피드를 생성할 수 있습니다. RSS와 Atom 피드는 기본적으로 생성됩니다. 피드 생성을 하지 않으려면 feedOptions.type 항목 값을 null로 설정해주세요.

feedOptions?: {  type?: 'rss' | 'atom' | 'all' | null;  title?: string;  description?: string;  copyright: string;  language?: string; // http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes 에서 사용할 수 있는 값을 확인할 수 있습니다.};

예를 들어 아래와 같이 설정할 수 있습니다.

docusaurus.config.js

module.exports = {  // ...  presets: [    [      '@docusaurus/preset-classic',      {        blog: {          feedOptions: {            type: 'all',            copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc.`,          },        },      },    ],  ],};

피드에 연결하는 방법은 아래와 같습니다.

RSS 피드

https://{your-domain}/blog/rss.xml

Atom 피드

https://{your-domain}/blog/atom.xml

블로그 기능 확장하기#

블로그 전용 모드#

도큐사우루스 2에서는 랜딩 페이지 없이 블로그 게시물 목록을 인덱스 페이지로 사용할 수 있습니다. routeBasePath 항목값을 '/'로 설정하면 루트 경로임을 나타냅니다.

docusaurus.config.js

module.exports = {  // ...  presets: [    [      '@docusaurus/preset-classic',      {        docs: false,        blog: {          path: './blog',          routeBasePath: '/', // 항목값을 '/'으로 설정합니다.        },      },    ],  ],};

caution

기존 랜딩 페이지로 사용하던 ./src/pages/index.js 파일을 삭제해주어야 합니다. 그렇지 않으면 같은 경로에 2개 파일이 연결되어집니다.

검색엔진최적화를 위해 블로그 게시물 목록 페이지에 메타 설명을 추가할 수 있습니다.

docusaurus.config.js

module.exports = {  // ...  presets: [    [      '@docusaurus/preset-classic',      {        blog: {          blogTitle: 'Docusaurus blog!',          blogDescription: 'A Docusaurus powered blog!',        },      },    ],  ],};

여러 개의 블로그 운영하기#

클래식 테마는 웹사이트에서 하나의 블로그만 관리한다고 가정하고 있습니다. 그래서 하나의 블로그 플러그인 인스턴스만 포함하고 있습니다. 물론 하나의 웹사이트에서 여러 개의 블로그를 운영하는 것도 가능합니다. docusaurus.config.js 옵션 중에서 plugins 항목을 설정해서 블로그 플러그인을 추가하면 또 하나의 블로그를 가질 수 있습니다.

routeBasePath 항목값은 두 번째 블로그에 접근할 수 있는 URL 경로를 설정해주어야 합니다. routeBasePath 항목값을 첫 번째 블로그와 다르게 설정한 것을 확인하세요. 그렇지 않으면 경로 충돌이 발생할 수 있습니다. 그리고 path 항목값도 두 번째 블로그 파일이 담겨있는 디렉터리를 설정해줍니다.

멀티 인스턴스 플러그인에서 설명하는 것처럼 플러그인은 유일한 id 항목값으로 설정해야 합니다.

docusaurus.config.js

module.exports = {  // ...  plugins: [    [      '@docusaurus/plugin-content-blog',      {        /**         * 멀티 인스턴스 플러그인 적용 시 필수값으로 설정해야 합니다.         */        id: 'second-blog',        /**         * 사이트에서 블로그 연결 시 사용할 URL 경로를 설정합니다.         * *절대* URL 끝에 슬래시를 붙이지 마세요.         */        routeBasePath: 'my-second-blog',        /**         * 사이트 디렉터리 기준으로 상대 경로를 지정합니다.         */        path: './my-second-blog',      },    ],  ],};

예제로 만든 두 번째 블로그를 확인해볼 수 있습니다.