📦 plugin-content-blog

블로그 만들기 기능을 제공하는 도큐사우루스의 기본 블로그 플러그인입니다.

설치

npm

npm install --save @docusaurus/plugin-content-blog

Yarn

yarn add @docusaurus/plugin-content-blog

tip

@docusaurus/preset-classic을 설치한 경우에는 테마를 따로 설치할 필요는 없습니다. 아래와 같이 설정하는 대신 classic preset options에서 설정할 수 있습니다.

설정

docusaurus.config.js

module.exports = {  plugins: [    [      '@docusaurus/plugin-content-blog',      {        /**         * 사이트 디렉터리의 상대 경로로 파일 시스템의 데이터 경로를 설정합니다.         */        path: 'blog',        /**         * 여러분의 사이트를 편집하기 위한 Base url을 설정합니다.         * 도큐사우루스는 "editUrl + relativeDocPath" 형식으로 실제 편집할 수 있는 editUrl을 처리합니다.         */        editUrl: 'https://github.com/facebook/docusaurus/edit/master/website/',        /**         * 필요에 따라 각 마크다운 파일의 editUrl을 직접 설정해줄 수 있습니다.         */        editUrl: ({locale, blogDirPath, blogPath, permalink}) => {          return `https://github.com/facebook/docusaurus/edit/master/website/${blogDirPath}/${blogPath}`;        },        /**         * 번역한 파일을 깃에 커밋하는 경우 유용한 설정입니다.         * 마크다운 파일을 현지화하게 되면 편집 URL은 현지화되지 않은 원본 파일 대신         * 현지화된 파일을 가리키게 됩니다.         * 참고: editUrl이 함수인 경우에는 해당 옵션은 무시합니다.         */        editLocalizedFiles: false,        /**         * 사이트 검색 최적화를 위한 블로그 제목을 설정합니다.         */        blogTitle: 'Blog title',        /**         * 사이트 검색 최적화를 위한 블로그 페이지 메타 설명을 설정합니다.         */        blogDescription: 'Blog',        /**         * 블로그 사이드바에서 표시할 블로그 포스트 개수를 설정합니다.         * 'ALL'로 설정하면 모든 블로그 포스트를 표시합니다.         * 0으로 설정하면 포스트를 표시하지 않습니다.         */        blogSidebarCount: 5,        /**         * 블로그 사이드바 제목을 설정합니다.         */        blogSidebarTitle: 'All our posts',        /**         * 여러분의 사이트 블로그 URL 경로를 설정합니다.         * *절대* URL 끝에 슬래시를 붙이지 마세요.         */        routeBasePath: 'blog',        include: ['*.md', '*.mdx'],        /**         * 아래 설정한 파일은 라우트 처리를 하지 않습니다.         */        exclude: [          '**/_*.{js,jsx,ts,tsx,md,mdx}',          '**/_*/**',          '**/*.test.{js,jsx,ts,tsx}',          '**/__tests__/**',        ],        postsPerPage: 10,        /**         * 블로그 페이지에서 사용하는 테마 컴포넌트입니다.         */        blogListComponent: '@theme/BlogListPage',        blogPostComponent: '@theme/BlogPostPage',        blogTagsListComponent: '@theme/BlogTagsListPage',        blogTagsPostsComponent: '@theme/BlogTagsPostsPage',        /**         * MDX에 전달할 Remark, Rehype 플러그인을 설정합니다.         */        remarkPlugins: [          /* require('remark-math') */        ],        rehypePlugins: [],        /**         * 기본 Remark, Rehype 플러그인이 적용되기 전에         * MDX에 사용자 지정 Remark, Rehype 플러그인을 전달하도록 설정합니다.         */        beforeDefaultRemarkPlugins: [],        beforeDefaultRehypePlugins: [],        /**         * 정규식 또는 문자열을 사용해 자르기를 설정합니다.         */        truncateMarker: /<!--\s*(truncate)\s*-->/,        /**         * 블로그 게시물의 예상 읽기 시간을 표시합니다.         */        showReadingTime: true,        /**         * 블로그 피드를 설정합니다.         * feedOptions을 설정하지 않으면 RSS 피드가 만들어지지 않습니다.         */        feedOptions: {          type: '', // 필수값. 'rss' | 'feed' | 'all'          title: '', // 기본값은 siteConfig.title 입니다.          description: '', // 기본값은 `${siteConfig.title} Blog`입니다.          copyright: '',          language: undefined, // 다음과 같은 값을 설정할 수 있습니다: http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes        },      },    ],  ],};

i18n

i18n 소개 문서를 먼저 확인해주세요.

번역 파일 위치

• 기본 경로: website/i18n/<locale>/docusaurus-plugin-content-blog
• 멀티 인스턴스 경로: website/i18n/<locale>/docusaurus-plugin-content-blog-<pluginId>
• JSON 파일: 해당없음
• 마크다운 파일: website/i18n/<locale>/docusaurus-plugin-content-blog

파일 시스템 구조 예

website/i18n/<locale>/docusaurus-plugin-content-blog││ # translations for website/blog├── first-blog-post.md└── second-blog-post.md