Додавање нових докумената
Додајте нове документе на свој сајт документације и blog.
За документацију
- Направите нову
.mdxдатотеку у фасциклиapps/content/docs/[language]са садржајем свог документа. - Додајте документ у навигациони мени сајта.
Да бисте то урадили, додајте нову ставку у датотеку
src/config/docs.tsу својствоsidebarNavса жељеним информацијама, пратећи образац постојећих ставки. Тиме ће документ бити додат и у command palette за претрагу.
Подешавања MDX документа
MDX документи се чувају у фасциклама apps/content/docs/[language] и apps/content/blog/[language]. Сваки документ је MDX датотека која садржи заглавље са metadata подацима, као што су наслов и опис. Испод је пример заглавља документа:
---
title: Document Title
description: Document Description.
sort: 1
---Подржана су следећа metadata поља:
title(обавезно): Наслов документа.description(обавезно): Кратак опис документа.sort(опционо): Број који одређује редослед документа у навигацији. Документи са нижим вредностимаsortприказују се први. Ако није наведено, документи се сортирају абецедно по наслову.links(опционо): Линкови ка повезаним документима, API референцама, изворном коду итд.toc(опционо): Да ли да се прикаже садржај. Подразумевано јеtrue.
Да бисте додали нове metadata податке у документ, можете додати нове кључеве у заглавље. На пример, можете додати кључ author да означите аутора документа:
---
title: Document Title
description: Document Description.
sort: 2
author: Author Name
---Али када додајете прилагођене metadata податке, такође морате да ажурирате датотеку contentlayer.config.ts која се налази у корену пројекта и унутар својства fields у константама Doc или Blog.
Након тога, мораћете да прикажете нове информације у шаблону документа. Да бисте то урадили, ажурирајте датотеку src/app/[locale]/docs/[[...slug]]/page.tsx, или src/app/[locale]/blog/[[...slug]]/page.tsx, или неку од њених подкомпоненти.
Поновна изградња Contentlayer-а
Када мењате садржај документације, додајете нове документе или мењате датотеку contentlayer.config.ts, мораћете поново да изградите contentlayer cache да би ваше измене имале ефекта током развоја. Покрените:
cd apps/web
pnpm contentlayer:buildОва команда поново генерише типове садржаја и податке потребне апликацији. Ову команду треба да покренете кад год:
- Додате нова metadata поља у датотеку
contentlayer.config.ts - Додате или измените MDX садржај када dev server није покренут
- Промените структуру организације садржаја
Команда се аутоматски покреће приликом build-а пројекта за production, али током развоја морате да је покренете ручно ако правите структурне измене садржаја.