๋ฉ”์ธ ์ปจํ…์ธ ๋กœ ์ด๋™
Version: 2.0.0-beta.4

๐Ÿ“ฆ plugin-content-docs

๋ฌธ์„œ ๋งŒ๋“ค๊ธฐ ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•˜๋Š” ๋„ํ์‚ฌ์šฐ๋ฃจ์Šค์˜ ๊ธฐ๋ณธ ๋ฌธ์„œ ํ”Œ๋Ÿฌ๊ทธ์ธ์ž…๋‹ˆ๋‹ค.

์„ค์น˜#

npm install --save @docusaurus/plugin-content-docs
tip

@docusaurus/preset-classic์„ ์„ค์น˜ํ•œ ๊ฒฝ์šฐ์—๋Š” ๊ธฐ๋ณธ ํŽ˜์ด์ง€ ํ”Œ๋Ÿฌ๊ทธ์ธ์„ ๋”ฐ๋กœ ์„ค์น˜ํ•  ํ•„์š”๋Š” ์—†์Šต๋‹ˆ๋‹ค. ์•„๋ž˜์™€ ๊ฐ™์ด ์„ค์ •ํ•˜๋Š” ๋Œ€์‹  classic preset options์—์„œ ์„ค์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์„ค์ •#

docusaurus.config.js
module.exports = {  plugins: [    [      '@docusaurus/plugin-content-docs',      {        /**         * ์‚ฌ์ดํŠธ ๋””๋ ‰ํ„ฐ๋ฆฌ์˜ ์ƒ๋Œ€ ๊ฒฝ๋กœ๋กœ ํŒŒ์ผ ์‹œ์Šคํ…œ์˜ ๋ฐ์ดํ„ฐ ๊ฒฝ๋กœ๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.         */        path: 'docs',        /**         * ์—ฌ๋Ÿฌ๋ถ„์˜ ์‚ฌ์ดํŠธ๋ฅผ ํŽธ์ง‘ํ•˜๊ธฐ ์œ„ํ•œ Base url์„ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.         * ๋„ํ์‚ฌ์šฐ๋ฃจ์Šค์—์„œ "editUrl + relativeDocPath" ์กฐํ•ฉ์œผ๋กœ ์ตœ์ข… editUrl์„ ๊ณ„์‚ฐํ•ฉ๋‹ˆ๋‹ค.         * ๊ฐ’์„ ์„ค์ •ํ•˜์ง€ ์•Š์œผ๋ฉด ํŽธ์ง‘ ๋งํฌ๋ฅผ ๋น„ํ™œ์„ฑํ™”ํ•ฉ๋‹ˆ๋‹ค.         */        editUrl: 'https://github.com/facebook/docusaurus/edit/master/website/',        /**         * ํ•„์š”์— ๋”ฐ๋ผ ๊ฐ ๋งˆํฌ๋‹ค์šด ํŒŒ์ผ์˜ editUrl์„ ์ง์ ‘ ์„ค์ •ํ•ด์ค„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.         */        editUrl: function ({          locale,          version,          versionDocsDirPath,          docPath,          permalink,        }) {          return `https://github.com/facebook/docusaurus/edit/master/website/${versionDocsDirPath}/${docPath}`;        },        /**         * ๋ฒˆ์—ญ๋œ ํŒŒ์ผ์„ ๊นƒ์— ์ปค๋ฐ‹ํ•˜๋Š” ๊ฒฝ์šฐ ์œ ์šฉํ•œ ์„ค์ •์ž…๋‹ˆ๋‹ค.         * ๋งˆํฌ๋‹ค์šด ํŒŒ์ผ์„ ํ˜„์ง€ํ™”ํ•˜๊ฒŒ ๋˜๋ฉด ํŽธ์ง‘ URL์€ ํ˜„์ง€ํ™”๋˜์ง€ ์•Š์€ ์›๋ณธ ํŒŒ์ผ ๋Œ€์‹          * ํ˜„์ง€ํ™”๋œ ํŒŒ์ผ์„ ๊ฐ€๋ฆฌํ‚ค๊ฒŒ ๋ฉ๋‹ˆ๋‹ค.         * ์ฐธ๊ณ : editUrl์ด ํ•จ์ˆ˜์ธ ๊ฒฝ์šฐ์— ํ•ด๋‹น ์˜ต์…˜์€ ๋ฌด์‹œ๋ฉ๋‹ˆ๋‹ค.         */        editLocalizedFiles: false,        /**         * ์ด์ „ ๋ฒ„์ „์— ๋Œ€ํ•œ ์‚ฌ์šฉ์ž์˜ ํ’€ ๋ฆฌํ€˜์ŠคํŠธ ์š”์ฒญ์„ ๋ง‰์„ ๊ฒฝ์šฐ ์œ ์šฉํ•ฉ๋‹ˆ๋‹ค.         * ๋ฌธ์„œ ๋ฒ„์ „์ด ์˜ฌ๋ผ๊ฐ„ ๊ฒฝ์šฐ ํŽธ์ง‘ํ•  ์ˆ˜ ์žˆ๋Š” url์€ ์ด์ „ ๋ฒ„์ „ ๋ฌธ์„œ ๋Œ€์‹          * ํ˜„์žฌ ๋ฒ„์ „ ๋ฌธ์„œ๋กœ ์—ฐ๊ฒฐ๋˜๋„๋ก ํ•ฉ๋‹ˆ๋‹ค.         * ์ฐธ๊ณ : editUrl์ด ํ•จ์ˆ˜์ธ ๊ฒฝ์šฐ์— ํ•ด๋‹น ์˜ต์…˜์€ ๋ฌด์‹œ๋ฉ๋‹ˆ๋‹ค.         */        editCurrentVersion: false,        /**         * ์—ฌ๋Ÿฌ๋ถ„์˜ ์‚ฌ์ดํŠธ ๋ฌธ์„œ ๋””๋ ‰ํ„ฐ๋ฆฌ์— ๋Œ€ํ•œ URL ๊ฒฝ๋กœ๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.         * *์ ˆ๋Œ€* URL ๋์— ์Šฌ๋ž˜์‹œ๋ฅผ ๋ถ™์ด์ง€ ๋งˆ์„ธ์š”.         * ์ฐธ๊ณ : base ๊ฒฝ๋กœ ์—†์ด ๋ฐฐํฌ๋˜๋Š” ๋ฌธ์„œ๋Š” `/`์„ ์„ค์ •ํ•  ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค.         */        routeBasePath: 'docs',        include: ['**/*.md', '**/*.mdx'], // Extensions to include.        /**         * ์•„๋ž˜ ์„ค์ •ํ•œ ํŒŒ์ผ์€ ๋ผ์šฐํŠธ ์ฒ˜๋ฆฌ๋ฅผ ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.         */        exclude: [          '**/_*.{js,jsx,ts,tsx,md,mdx}',          '**/_*/**',          '**/*.test.{js,jsx,ts,tsx}',          '**/__tests__/**',        ],        /**         * ๋งˆํฌ๋‹ค์šด ํŽ˜์ด์ง€ ๋ชฉ๋ก์„ ๋ณด์—ฌ์ฃผ๊ธฐ ์œ„ํ•œ ์‚ฌ์ด๋“œ๋ฐ” ๊ตฌ์„ฑ ๊ฒฝ๋กœ์ž…๋‹ˆ๋‹ค.         */        sidebarPath: 'sidebars.js',        /**         * ๋ชจ๋“  ์‚ฌ์ด๋“œ๋ฐ” ์นดํ…Œ๊ณ ๋ฆฌ๋Š” ์ ‘์„ ์ˆ˜ ์žˆ๋Š” ์ƒํƒœ๊ฐ€ ๊ธฐ๋ณธ๊ฐ’์ž…๋‹ˆ๋‹ค.         * ์นดํ…Œ๊ณ ๋ฆฌ ๋ณ„๋กœ ์˜ต์…˜์„ ์„ค์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.         */        sidebarCollapsible: true,        /**         * ๋ชจ๋“  ์‚ฌ์ด๋“œ๋ฐ” ์นดํ…Œ๊ณ ๋ฆฌ๋Š” ์ ‘ํ˜€์ ธ ์žˆ๋Š” ์ƒํƒœ๊ฐ€ ๊ธฐ๋ณธ๊ฐ’์ž…๋‹ˆ๋‹ค.         * ์นดํ…Œ๊ณ ๋ฆฌ ๋ณ„๋กœ ์˜ต์…˜์„ ์„ค์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.         */        sidebarCollapsed: false,        /**         * "autogenerated" ํƒ€์ž…์˜ ์‚ฌ์ด๋“œ๋ฐ” ์•„์ดํ…œ์„ ์‹ค์ œ ์‚ฌ์ด๋“œ๋ฐ” ์•„์ดํ…œ(๋ฌธ์„œ, ์นดํ…Œ๊ณ ๋ฆฌ, ๋งํฌ ๋“ฑ)์œผ๋กœ         * ๋ฐ”๊พธ๊ธฐ ์œ„ํ•ด ์‚ฌ์šฉํ•˜๋Š” ํ•จ์ˆ˜์ž…๋‹ˆ๋‹ค.         */        sidebarItemsGenerator: async function ({          defaultSidebarItemsGenerator, // ๋„ํ์‚ฌ์šฐ๋ฃจ์Šค์—์„œ ์‚ฌ์ด๋“œ๋ฐ”๋ฅผ ๋งŒ๋“œ๋Š” ๊ธฐ๋ณธ ๋กœ์ง์„ ์žฌ์‚ฌ์šฉํ•˜๊ฑฐ๋‚˜ ํ–ฅ์ƒ์‹œํ‚ฌ ๋•Œ ์œ ์šฉํ•ฉ๋‹ˆ๋‹ค.          numberPrefixParser, // ํ”Œ๋Ÿฌ๊ทธ์ธ์„ ์œ„ํ•œ numberPrefixParser๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.          item, // "autogenerated" ํƒ€์ž…์˜ ์‚ฌ์ด๋“œ๋ฐ” ์•„์ดํ…œ์ž…๋‹ˆ๋‹ค.          version, // ํ˜„์žฌ ๋ฒ„์ „์„ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.          docs, // ํ•ด๋‹น ๋ฒ„์ „์˜ ๋ชจ๋“  ๋ฌธ์„œ(ํ•„ํ„ฐ๋งํ•˜์ง€ ์•Š์€)๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.        }) {          // ์‚ฌ์šฉ์ž ์ง€์ • ์‚ฌ์ด๋“œ๋ฐ” ์Šฌ๋ผ์ด์Šค๋ฅผ ๋งŒ๋“ค๊ธฐ ์œ„ํ•ด ์ฃผ์–ด์ง„ ๋ฐ์ดํ„ฐ๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.          return [            {type: 'doc', id: 'intro'},            {              type: 'category',              label: 'Tutorials',              items: [                {type: 'doc', id: 'tutorial1'},                {type: 'doc', id: 'tutorial2'},              ],            },          ];        },        /**         * ๋ฌธ์„œ ํ”Œ๋Ÿฌ๊ทธ์ธ์€ "01-My Folder/02.My Doc.md"๊ฐ™์€ ์ˆซ์ž ํ˜•์‹์˜ ์ ‘๋‘์‚ฌ๋ฅผ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.         * ๋ฒˆํ˜ธ ์ ‘๋‘์‚ฌ๋Š” ์ž๋™์œผ๋กœ ์ถ”์ถœ๋˜์–ด ์ž๋™ ์ƒ์„ฑ๋œ ์‚ฌ์ด๋“œ๋ฐ” ์•„์ดํ…œ์˜ ์ •๋ ฌ ์ˆœ์„œ๋กœ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค.         * ์‚ฌ์šฉ์„ฑ์„ ์œ„ํ•ด ๊ธฐ๋ณธ ๋ฌธ์„œ์˜ id, ์ด๋ฆ„, ์ œ๋ชฉ์—์„œ ์ˆซ์ž ์ ‘๋‘์‚ฌ๋Š” ์ž๋™์œผ๋กœ ์ œ๊ฑฐ๋ฉ๋‹ˆ๋‹ค.         * ๊ตฌ๋ฌธ ๋ถ„์„์„ ์œ„ํ•œ ๋กœ์ง์—์„œ ๋ชจ๋“  ์‚ฌ์šฉ ๋ฐฉ์‹๊ณผ ํŒŒ์ผ๋ช… ํŒจํ„ด์„ ํ—ˆ์šฉํ•˜๋„๋ก ์„ค์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.         * "false"๋ฅผ ์„ค์ •ํ•˜๋ฉด ์•„๋ฌด ๋™์ž‘ ์—†์ด ๋ฌธ์„œ๋ฅผ ๊ฑด๋“œ๋ฆฌ์ง€ ์•Š์€ ์ƒํƒœ๋กœ ์œ ์ง€ํ•ฉ๋‹ˆ๋‹ค.         */        numberPrefixParser: function (filename) {          // ์ž ์žฌ์ ์ธ ๋ฒˆํ˜ธ ์ ‘๋‘์‚ฌ๋ฅผ ์ถ”์ถœํ•˜๊ธฐ ์œ„ํ•œ ์‚ฌ์šฉ์ž ์ง€์ • ๋กœ์ง์„ ๊ตฌํ˜„ํ•ฉ๋‹ˆ๋‹ค.          const numberPrefix = findNumberPrefix(filename);          // ์ ‘๋‘์‚ฌ๋ฅผ ๋ฐœ๊ฒฌํ•˜๋ฉด ์ˆ˜์ •๋œ ํŒŒ์ผ๋ช…๊ณผ ํ•จ๊ป˜ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.          if (numberPrefix) {            return {              numberPrefix,              filename: filename.replace(prefix, ''),            };          }          // ์ ‘๋‘์‚ฌ๊ฐ€ ๋ณ„๊ฒฌ๋˜์ง€ ์•Š์œผ๋ฉด          return {numberPrefix: undefined, filename};        },        /**         * ๋ฌธ์„œ ํŽ˜์ด์ง€์—์„œ ์‚ฌ์šฉํ•  ํ…Œ๋งˆ ์ปดํฌ๋„ŒํŠธ๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.         */        docLayoutComponent: '@theme/DocPage',        docItemComponent: '@theme/DocItem',        /**         * MDX์— ์ „๋‹ฌํ•  Remark, Rehype ํ”Œ๋Ÿฌ๊ทธ์ธ์„ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.         */        remarkPlugins: [          /* require('remark-math') */        ],        rehypePlugins: [],        /**         * ๊ธฐ๋ณธ Remark, Rehype ํ”Œ๋Ÿฌ๊ทธ์ธ์ด ์ ์šฉ๋˜๊ธฐ ์ „์—         * MDX์— ์‚ฌ์šฉ์ž ์ง€์ • Remark, Rehype ํ”Œ๋Ÿฌ๊ทธ์ธ์„ ์ „๋‹ฌํ•˜๋„๋ก ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.         */        beforeDefaultRemarkPlugins: [],        beforeDefaultRehypePlugins: [],        /**         * ๋งˆ์ง€๋ง‰์œผ๋กœ ๋ฌธ์„œ๋ฅผ ์ˆ˜์ •ํ•œ ์‚ฌ์šฉ์ž๋ฅผ ํ‘œ์‹œํ• ์ง€ ์—ฌ๋ถ€๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.         */        showLastUpdateAuthor: false,        /**         * ๋งˆ์ง€๋ง‰์œผ๋กœ ๋ฌธ์„œ๋ฅผ ์ˆ˜์ •ํ•œ ์ผ์ž๋ฅผ ํ‘œ์‹œํ• ์ง€ ์—ฌ๋ถ€๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.         */        showLastUpdateTime: false,        /**         * ๊ธฐ๋ณธ์ ์œผ๋กœ ๋ฌธ์„œ ๋ฒ„์ „์„ ๊ด€๋ฆฌํ•˜๋Š” ์‚ฌ์ดํŠธ๋Š” ๋ฒ„์ „ ๊ด€๋ฆฌ ๊ธฐ๋Šฅ์ด ํ™œ์„ฑํ™”๋ฉ๋‹ˆ๋‹ค.         * ์•„๋ž˜ ์˜ต์…˜์€ ๋ช…์‹œ์ ์œผ๋กœ ๋ฒ„์ „ ๊ด€๋ฆฌ ๊ธฐ๋Šฅ์„ ๋น„ํ™œ์„ฑํ™”ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.         * "current" ๋ฒ„์ „ (`/docs` ๋””๋ ‰ํ„ฐ๋ฆฌ)์—๋งŒ ์ ์šฉ๋ฉ๋‹ˆ๋‹ค.         */        disableVersioning: false,        /**         * ๋ฌธ์„œ์˜ "current" ๋ฒ„์ „(`/docs` ๋””๋ ‰ํ„ฐ๋ฆฌ) ํฌํ•จ ์—ฌ๋ถ€๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.         * ํŒ: current ๋ฒ„์ „์ด ์ž‘์—…์ค‘์ด๊ณ  ์•„์ง ๋ฐฐํฌํ•  ์ค€๋น„๊ฐ€ ๋˜์ง€ ์•Š์•˜์„ ๋•Œ ๊บผ๋†“์Šต๋‹ˆ๋‹ค.         */        includeCurrentVersion: true,        /**         * ๋งˆ์ง€๋ง‰ ๋ฒ„์ „์€ ๋ฒ„์ „ ๊ด€๋ฆฌ๋ฅผ ์ ์šฉํ•œ ์‚ฌ์ดํŠธ์—์„œ ์šฐ์„ ์ ์œผ๋กœ ํƒ์ƒ‰ํ•˜๋Š” ๋Œ€์ƒ์ž…๋‹ˆ๋‹ค.         * ๋ฌธ์„œ ํƒ์ƒ‰๋ฐ”์—์„œ ๊ธฐ๋ณธ๊ฐ’์œผ๋กœ ํ‘œ์‹œ๋˜๋Š” ๊ฐ’์ž…๋‹ˆ๋‹ค.         * ๊ธฐ๋ณธ์ ์œผ๋กœ ๋งˆ์ง€๋ง‰ ๋ฒ„์ „์€ versions.json ํŒŒ์ผ ๋‚ด ์ฒซ ํ•ญ๋ชฉ์— ์œ„์น˜ํ•œ ๊ฐ’์ž…๋‹ˆ๋‹ค.         * ๊ธฐ๋ณธ์ ์œผ๋กœ ๋งˆ์ง€๋ง‰ ๋ฒ„์ „์€ "root" (๋ฌธ์„œ ๊ฒฝ๋กœ=/docs/myDoc)์— ์œ„์น˜ํ•ฉ๋‹ˆ๋‹ค.         * ์ฐธ๊ณ : ๋งˆ์ง€๋ง‰ ๋ฒ„์ „์˜ ๊ฒฝ๋กœ์™€ ํ‘œ์‹œ๋˜๋Š” ๊ฐ’์„ ์„ค์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.         * ํŒ: 'current'๋กœ ๊ฐ’์„ ์„ค์ •ํ•˜๋ฉด ๋Œ€๋ถ€๋ถ„ ๋ฌธ์ œ๊ฐ€ ์—†์Šต๋‹ˆ๋‹ค.         */        lastVersion: undefined,        /**         * ๋„ํ์‚ฌ์šฐ๋ฃจ์Šค์— ๊ธฐ๋ณธ ์˜ˆ๋กœ ์„ค์ •ํ•œ versions ์„ค์ •๊ฐ’์€ ๋Œ€๋ถ€๋ถ„ ํ”„๋กœ์ ํŠธ์— ์ ํ•ฉํ•˜์ง€๋Š” ์•Š์Šต๋‹ˆ๋‹ค.         * ๊ฐ ๋ฒ„์ „์˜ ์†์„ฑ์„ ๋…๋ฆฝ์ ์œผ๋กœ ์‚ฌ์šฉ์ž๊ฐ€ ์ •์˜ํ•˜๊ณ ์ž ํ• ๋•Œ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.         * - label: ๋ฒ„์ „ ํ‘œ์‹œ๊ฐ’         * - path: ๋ฒ„์ „์˜ ๋ผ์šฐํŠธ ๊ฒฝ๋กœ         * - banner: ํ•ด๋‹น ๋ฒ„์ „ ๋ฌธ์„œ ์ƒ๋‹จ์— ํ‘œ์‹œํ•  ๋ฐฐ๋„ˆ: "none" | "unreleased" | "unmaintained"         */        versions: {          /*          Example configuration:           current: {            label: 'Android SDK v2.0.0 (WIP)',            path: 'android-2.0.0',            banner: 'none',          },          '1.0.0': {            label: 'Android SDK v1.0.0',            path: 'android-1.0.0',            banner: 'unmaintained',          },          */        },        /**         * ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋Š” ๋ฒ„์ „ ์ค‘ ์ผ๋ถ€๋งŒ ํฌํ•จํ•˜๋ ค๋Š” ๊ฒฝ์šฐ ์‚ฌ์šฉํ•˜๋Š” ์˜ต์…˜์ž…๋‹ˆ๋‹ค.         * ํŒ: ๊ฐœ๋ฐœ ๋ฐ ๋ฐฐํฌ ๋ฏธ๋ฆฌ ๋ณด๊ธฐ ์ƒํƒœ์—์„œ๋Š” ์‹œ์ž‘ ๋ฐ ๋นŒ๋“œ ์„ฑ๋Šฅ์„ ํ–ฅ์ƒ์‹œํ‚ค๊ธฐ ์œ„ํ•ด 2~3๊ฐœ ์ •๋„ ๋ฒ„์ „๋งŒ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค.         */        onlyIncludeVersions: undefined, // ์˜ˆ: ["current", "1.0.0", "2.0.0"]      },    ],  ],};

๋งˆํฌ๋‹ค์šด ํ”„๋ŸฐํŠธ ๋งคํ„ฐ#

๋งˆํฌ๋‹ค์šด ๋ฌธ์„œ์—์„œ๋Š” ---๋กœ ๊ฐ์‹ผ ๋งˆํฌ๋‹ค์šด ํ”„๋ŸฐํŠธ ๋งคํ„ฐ ์˜์—ญ์—์„œ ์•„๋ž˜์™€ ๊ฐ™์€ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ ํ•„๋“œ๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

  • id: ์œ ์ผํ•œ ๋ฌธ์„œ id์ž…๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’: ํŒŒ์ผ ๊ฒฝ๋กœ(ํ™•์žฅ์ž๋Š” ์ œ์™ธํ•˜๊ณ  ๋””๋ ‰ํ„ฐ๋ฆฌ๋Š” ํฌํ•จ)
  • title: ๋ฌธ์„œ ์ œ๋ชฉ์ž…๋‹ˆ๋‹ค. ํŽ˜์ด์ง€ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋กœ ์‚ฌ์šฉํ•˜๋ฉฐ ์—ฌ๋Ÿฌ ์œ„์น˜(์‚ฌ์ด๋“œ๋ฐ”, ๋‹ค์Œ/์ด์ „ ๋ฒ„ํŠผ ๋“ฑ)์—์„œ ๋Œ€์ฒด๊ฐ’์œผ๋กœ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๋งˆํฌ๋‹ค์šด ์ œ๋ชฉ์ด ์—†๋Š” ๊ฒฝ์šฐ ๋ฌธ์„œ ์ƒ๋‹จ์— ์ž๋™์œผ๋กœ ์ถ”๊ฐ€๋ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’: ๋งˆํฌ๋‹ค์šด ์ œ๋ชฉ ๋˜๋Š” ๋ฌธ์„œ id
  • hide_title: ๋ฌธ์„œ ์ƒ๋‹จ์—์„œ ์ œ๋ชฉ์„ ์ˆจ๊ธธ์ง€ ์—ฌ๋ถ€๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค. ํ”„๋ŸฐํŠธ ๋งคํ„ฐ ์˜์—ญ์—์„œ ์„ค์ •ํ•œ ์ œ๋ชฉ๋งŒ ๊ฐ์ถฅ๋‹ˆ๋‹ค. ๋งˆํฌ๋‹ค์šด ๋ฌธ์„œ ๋‚ด์— ์ง€์ •๋œ ํƒ€์ดํ‹€์—๋Š” ์˜ํ–ฅ์„ ์ฃผ์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’: false
  • hide_table_of_contents: ์˜ค๋ฅธ์ชฝ์— ํ‘œ์‹œ๋˜๋Š” ๋ชฉ์ฐจ ์ˆจ๊น€ ์—ฌ๋ถ€๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’: false
  • sidebar_label: ๋ฌธ์„œ ๋‚ด์—์„œ ๋ฌธ์„œ์˜ ์‚ฌ์ด๋“œ๋ฐ”์— ํ‘œ์‹œํ•  ํ…์ŠคํŠธ๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’: title
  • sidebar_position: autogenerated ์‚ฌ์ด๋“œ๋ฐ” ์•„์ดํ…œ์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ ๋งŒ๋“ค์–ด์ง„ ์‚ฌ์ด๋“œ๋ฐ” ์Šฌ๋ผ์ด์Šค ๋‚ด์—์„œ ๋ฌธ์„œ ์œ„์น˜๋ฅผ ์กฐ์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Int ๋˜๋Š” Float ๊ฐ’์„ ์„ค์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • pagination_label: ๋ฌธ์„œ ๋‚ด์—์„œ ๋ฌธ์„œ์˜ ๋‹ค์Œ/์ด์ „ ๋ฒ„ํŠผ์— ํ‘œ์‹œํ•  ํ…์ŠคํŠธ๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’: sidebar_label ๋˜๋Š” title
  • parse_number_prefixes: ๋ฌธ์„œ์— ๋ฒˆํ˜ธ ์ ‘๋‘์‚ฌ(001 - My Doc.md, 2. MyDoc.md...)๊ฐ€ ์žˆ๋Š” ๊ฒฝ์šฐ numberPrefixParser ํ”Œ๋Ÿฌ๊ทธ์ธ์—์„œ ์ž๋™์œผ๋กœ ๊ตฌ๋ฌธ์„ ๋ถ„์„ํ•˜๊ณ  ์ถ”์ถœํ•ด sidebar_position์œผ๋กœ ๋ฒˆํ˜ธ ์ ‘๋‘์‚ฌ๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. parse_number_prefixes: false๋กœ ์„ค์ •ํ•˜๋ฉด ๋ฌธ์„œ์—์„œ ๋ฒˆํ˜ธ ์ ‘๋‘์‚ฌ ๊ตฌ๋ฌธ ๋ถ„์„์„ ์‚ฌ์šฉํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’: parse_number_prefixes ํ”Œ๋Ÿฌ๊ทธ์ธ ์˜ต์…˜
  • custom_edit_url: ๋ฌธ์„œ๋ฅผ ํŽธ์ง‘ํ•  ์ˆ˜ ์žˆ๋Š” URL์„ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’: editUrl ํ”Œ๋Ÿฌ๊ทธ์ธ ์˜ต์…˜์„ ์‚ฌ์šฉํ•ด ๊ณ„์‚ฐ๋œ ๊ฐ’
  • keywords: ๊ฒ€์ƒ‰ ์—”์ง„์—์„œ ํ•„์š”ํ•œ ๋ฌธ์„œ ํŽ˜์ด์ง€์˜ ํ‚ค์›Œ๋“œ ๋ฉ”ํƒ€ ํƒœ๊ทธ๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.
  • description: ๋ฌธ์„œ์˜ ์„ค๋ช…์€ ๊ฒ€์ƒ‰์—”์ง„์—์„œ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๊ฒŒ <head> ํƒœ๊ทธ ์•ˆ์— <meta name="description" content="..."/>์™€ <meta property="og:description" content="..."/>๋กœ ์ฒ˜๋ฆฌ๋ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’: ๋งˆํฌ๋‹ค์šด ์ฝ˜ํ…์ธ  ์ฒซ ๋ฒˆ์งธ ์ค„
  • image: ๊ฒŒ์‹œ๊ธ€์— ๋Œ€ํ•œ ๋งํฌ๋ฅผ ํ‘œ์‹œํ•  ๋•Œ ๋ณด์—ฌ์ง€๋Š” ์ปค๋ฒ„ ๋˜๋Š” ์„ฌ๋„ค์ผ ์ด๋ฏธ์ง€๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.
  • slug: ๋ฌธ์„œ url์„ ๋ณ€๊ฒฝํ•  ์ˆ˜ ์žˆ๋„๋ก ํ—ˆ์šฉํ•ฉ๋‹ˆ๋‹ค(/<routeBasePath>/<slug>). ์—ฌ๋Ÿฌ ํŒจํ„ด์„ ์„ค์ •ํ•  ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค: slug: my-doc, slug: /my/path/myDoc, slug: /.

์˜ˆ๋ฅผ ๋“ค๋ฉด ์•„๋ž˜์™€ ๊ฐ™์ด ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.

---id: doc-markdowntitle: Docs Markdown Featureshide_title: falsehide_table_of_contents: falsesidebar_label: Markdownsidebar_position: 3pagination_label: Markdown featurescustom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.mddescription: How do I find you when I cannot solve this problemkeywords:  - docs  - docusaurusimage: https://i.imgur.com/mErPwqL.pngslug: /myDoc---# Markdown Features
My Document Markdown content

i18n#

i18n ์†Œ๊ฐœ ๋ฌธ์„œ๋ฅผ ๋จผ์ € ํ™•์ธํ•ด์ฃผ์„ธ์š”.

๋ฒˆ์—ญ ํŒŒ์ผ ์œ„์น˜#

  • ๊ธฐ๋ณธ ๊ฒฝ๋กœ: website/i18n/<locale>/docusaurus-plugin-content-docs
  • ๋ฉ€ํ‹ฐ ์ธ์Šคํ„ด์Šค ๊ฒฝ๋กœ: website/i18n/<locale>/docusaurus-plugin-content-docs-<pluginId>
  • JSON ํŒŒ์ผ: docusaurus write-translations ๋ช…๋ น ์‹คํ–‰ ํ›„ ๋งŒ๋“ค์–ด์ง„ ํŒŒ์ผ
  • ๋งˆํฌ๋‹ค์šด ํŒŒ์ผ: website/i18n/<locale>/docusaurus-plugin-content-docs/<version>

ํŒŒ์ผ ์‹œ์Šคํ…œ ๊ตฌ์กฐ ์˜ˆ#

website/i18n/<locale>/docusaurus-plugin-content-docsโ”‚โ”‚ # translations for website/docsโ”œโ”€โ”€ currentโ”‚ย ย  โ”œโ”€โ”€ apiโ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ config.mdโ”‚ย ย  โ””โ”€โ”€ getting-started.mdโ”œโ”€โ”€ current.jsonโ”‚โ”‚ # translations for website/versioned_docs/version-1.0.0โ”œโ”€โ”€ version-1.0.0โ”‚ย ย  โ”œโ”€โ”€ apiโ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ config.mdโ”‚ย ย  โ””โ”€โ”€ getting-started.mdโ””โ”€โ”€ version-1.0.0.json