Skip to main content

Dokumentacija - kako je pokrenuti lokalno

Početak​

Šta će vam biti potrebno​

Klonirajte ovaj repozitorijum​

git clone git@github.com:cuvarko/cuvarko-docs.git

Pokrenite dokumentaciju lokalno​

Pokrenite razvojni server:

cd cuvarko-docs
npm run start

Komanda npm run start pokreće lokalni server na http://localhost:3030/.

Otvorite docs/intro.md (ovu stranicu) i izmenite neke linije: sajt se automatski osvežava i prikazuje vaše promene.

U dokumentaciji se koristi Markdown za formatiranje teksta. Ako ste već koristili GitHub, verovatno ste već upoznati sa njim. Ako niste, ne brinite, lako je naučiti.

Dodajte novu stranicu​

Da biste dodali novu stranicu, napravite novi fajl u docs/ direktorijumu. Na primer, docs/new-page.md.

Dodajte nekoliko linija u novi fajl:

---
id: new-page
title: Nova stranica
sidebar_label: Nova stranica
---

Možete da pišete tekst u **Markdown**-u.

Otvorite website/sidebars.js i dodajte novu stranicu u docs sekciju:

module.exports = {
  docs: [
    "intro",
    "new-page", // Dodajte ovu liniju
  ],
};

Vaša nova stranica će biti dostupna na http://localhost:3030/new-page.

Slično je i sa izmenama postojećih stranica. Izmenite neku stranicu i sačekajte da se stranica osveži.

Kako objaviti izmene​

Kada ste zadovoljni sa izmenama, možete ih objaviti. Build i deploy se automatski pokreću kada se izmene objave na master grani i kad se izmene push-uju na GitHub.

cd cuvarko-docs
git add .
git commit -m "docs: Opis izmena"
git push

Nakon toga, izmene će biti dostupne na https://docs.cuvarko.com/docs/intro.