Направите веб локацију за документе помоћу Нект.јс користећи Нектра

Ако сте упознати са Нект.јс, можете га користити да са лакоћом развијете веб локацију за документацију. Оквир Нектра се брине о најситнијим стварима за вас; све што треба да урадите је да додате Маркдовн или ХТМЛ садржај и ИАМЛ или ЈСОН податке.

Прођите кроз ове кораке да бисте направили локацију за документацију користећи Нектра, генератор статичке локације заснован на Нект.јс. Инсталираћете и подесити неопходне зависности, а затим научити како да додате нове документе и странице, напишете Маркдовн и укључите Реацт компоненте.

Захтеви за прављење Доц сајта помоћу Нектра

Почните тако што ћете инсталирати Ноде.јс ако то већ нисте урадили. Тхе најновија верзија Ноде.јс долази са нпм, менаџером пакета чворова, који ће вам требати да инсталирате зависности за овај пројекат.

Поред Ноде.јс-а, мораћете да инсталирате Гит. Потребан вам је Гит да бисте поставили локацију на ГитХуб странице, Нетлифи или другог хостинг провајдера. Такође ће вам требати напредни уређивач кода, као што је ВС Цоде.

Инсталирање Нектра

Можете користити а нектра доцс шаблон да покренете сајт за документацију. Покрените командну линију и идите до директоријума у ​​којем желите да поставите свој пројекат. Затим покрените следећу команду да бисте покренули локацију документације:

гит цлоне https://github.com/shuding/nextra-docs-template

Ова команда ће поставити апликацију унутар тренутног директоријума. Затим покрените следећу команду да бисте инсталирали зависности:

цд нектра-доцс-темплате
нпм инсталл

Када се инсталација заврши, покрените апликацију. Урадите то тако што ћете покренути следећу команду на свом терминалу:

нпм рун дев

Ова команда покреће развојни сервер на локалном хосту: 3000. Пратите везу на свом терминалу да бисте погледали сајт за документацију. Почетна страница би требало да изгледа овако:

Ако погледате леву страну странице, наћи ћете странице са именом Увод и Друга страница. Испод ових линкова страница, наћи ћете страницу под називом Сатори, угнежђену унутар Напредно (Фолдер) именик. Коначно, у области за навигацију, наћи ћете везе до О томе и Контакт странице.

Да бисте разумели како ове странице функционишу, прво морате да разумете како Нект.јс приказује странице.

Разумевање структуре именика

Пошто Нектра користи Нект.јс оквир, она приказује сваку датотеку у странице/ фолдер као посебна страница.

Унутар странице директоријум, наћи ћете четири датотеке шаблона: абоут.мдк, адванцед.мдк, анотхер.мдк, и индек.мдк. Свака од ових датотека одговара страници на веб локацији; на пример, индек.мдк одговара почетној страници. УРЛ лоцалхост: 3000/око одговара абоут.мдк, и тако даље.

У странице, постоји и фасцикла под називом напредно, који садржи једну датотеку под називом сатори.мдк. УРЛ за ову датотеку ће бити локални хост: 3000/напредни/сатори.

Обратите пажњу на то како се свака од ових датотека завршава са а .мдк проширење.

Шта је МДКС?

Ако имате искуство са Реацт-ом, требало би да знате за ЈСКС. Ово је језик сличан ХТМЛ-у који можете користити да опишете кориснички интерфејс Реацт компоненти.

МДКС учитава, анализира и приказује ЈСКС у Маркдовн документу. Захваљујући МДКС-у, можете написати Реацт компоненте и увести их у своје Маркдовн документе када је то потребно. МДКС датотеке завршавају се екстензијом .мдк и могу укључивати Маркдовн и ЈСКС.

МДКС вам омогућава да комбинујете своје знање о Маркдовн-у са Реацт-ом да бисте креирали компоненте за вишекратну употребу. Можете креирајте ЦСС модуле да стилизујете компоненте. Ово вам помаже да организујете своје компоненте како бисте побољшали читљивост и одржавање.

Како уредити постојеће странице на локацији за документацију

Да бисте уредили постојећу страницу, једноставно отворите одговарајућу датотеку и унесите измене у њу. Подржани језици су Маркдовн и ЈСКС.

На пример, отворите индек.мдк датотеку и замените садржај овим:

# Добродошли у моју документацију
Драго ми је да те видим овде. Хвала
## Моје друштвене мреже
Прати ме; прати ме у [Твиттер](https://twitter.com/kingchuuks) и [ЛинкедИн](https://linkedin.com/in/kingchuks)

Овај пример користи Маркдовн за форматирање садржаја. Садржи наслов првог нивоа, наслов другог нивоа и две везе до друштвених медија.

Сачувајте датотеку и посетите почетну страницу вашег сајта за документацију. Страница би сада требало да изгледа овако:

На дну странице можете пронаћи и датум последњег ажурирања документа.

Додавање нове странице

Пре него што додате нову страницу, прво морате да одлучите да ли ће страница бити у странице/ директоријум или унутар фолдера у њему. Користите фасцикле ако желите да категоризујете своје странице или да развијете хијерархију.

У овом случају, направите самосталну страницу на највишем нивоу. Отворите датотеку под називом Инсталлатион.мдк у уређивачу кода и налепите следећи Маркдовн код у њега:

# Упутство за инсталацију
Пратите овај водич да бисте инсталирали мој пакет у свој пројекат
## 1. Инсталирајте Ноде.јс
Да бисте инсталирали Ноде.јс, посетите
[Сајт за документацију Ноде.јс](https://nodejs.org/en/download)

Сачувајте датотеку и проверите претраживач. Наћи ћете ознаку за инсталацију у бочном менију. Када кликнете на везу, садржај од Инсталлатион.мдк приказује на страници:

Можете да промените ознаку и извршите друге конфигурације у датотеци _мета.јсон унутар директоријума страница. Да бисте сазнали више о овоме, погледајте Организујте датотеке одељак оф Нектрина документација.

Коришћење Реацт компоненти

МДКС датотеке могу укључивати ЈСКС, што је језик који Реацт користи. Можете креирати компоненту унутар фолдера компоненти и увести је у било који од докумената на вашој веб локацији.

Можете видети пример како можете да уградите компоненте у Маркдовн у анотхер.мдк фајл:

## Саставни део
увези {усеСтате} из 'реацт'
увезите стилове из '../цомпонентс/цоунтерс.модуле.цсс'
екпорт цонст Цоунтер = () => { 
 цонст [цоунт, сетЦоунт] = усеСтате (0); 
 врати ( 

 сетЦоунт (цоунт+1)} цлассНаме={стилес.цоунтер}> 
 Кликовано {цоунт} пута