Preporuka za doc/manual rešenje?

• 0Niko još nije pohvalio poruku.
  Registruj se da bi pohvalio/la poruku!

Potrebno mi je moderno i besplatno rešenje za prikaz uputstva i dokumentaciju koda, koje bih ja hostovao na mom sajtu.

Evo primera koji mi se dopadaju :
https://developer.paypal.com/docs/integration/web/
https://docs.unity3d.com/Manual/PhysicsSection.html
https://docs.unity3d.com/ScriptReference/Events.Un.....tener.html

Tražio sam svašta nešto i uglavnom se svodi na skupa rešenja, open source ili neku wiki stranicu.
Wiki bi svakako poslužila ali mislim da nije to baš ono što meni treba.

Kapiram da bih to mogao i sam da uradim nekako verovatno ali ne bih da trošim vreme na to ako postoji neko rešenje.

Mislim da mi neće trebati ništa kompleksno ili previše ozbiljno.

• 0Niko još nije pohvalio poruku.
  Registruj se da bi pohvalio/la poruku!

Tražio sam i ja skoro slično rešenje, nešto nalik ovom. I oni su implementirali custom rešenje. Mislim da su ti u ovom trenutku najbolje neke od ove dve solucije:

- Ako ti se sviđa ovo možeš da probaš da iskoristiš to i da ga izmeniš po svojoj potrebi (i naravno, da podesiš sa serverske strane da ti se vuče sadržaj odnekud preko zahteva), ali to bi ti oduzelo vremena
- Da koristiš neke već postojeće generatore dokumentacije dostupne za okruženje (pretpostavljam da je VS u pitanju)

Nažalost, na neka bolja rešenja nisam uspeo da naiđem. U svakom slučaju pohvala za temu jer i mene zanima ista stvar

• 0Niko još nije pohvalio poruku.
  Registruj se da bi pohvalio/la poruku!

Kako god da okrenem, za dokumentaciju sa uputstvima, bez samog koda, ću morati sam da pišem sve od nule. Meni je to trenutno bitnije. Nadao sam se da postoji gotovo rešenje a ne da ja sada pravim 20 pojedinačnih stranica i linkujem ih, pa proveravam itd.

Što se koda tiče, to bih verovatno pokušao da rešim custom aplikacijom koja bi generisala html stranice za svaku funkciju iz XML-a koji se automatski generiše iz koda. Nalazio sam i ja na svašta nešto ali ...

Videću da li Džumla ima neku ekstenziju koja bi mi rešila deo sa uputstvima, dok ću za kod videti kasnije pa verovatno programom posebno praviti.


Jeste VS, C#, Unity.

• 0Niko još nije pohvalio poruku.
  Registruj se da bi pohvalio/la poruku!

ja sam koristio sphinx za generisanje python dokumentacije, prilicno sam bio zadovoljan kako mi je odradio posao. Valjda ima za C# nesto slicno.

• 1Ovo se svidja korisniku: E.L.I.T.E.
  
  Registruj se da bi pohvalio/la poruku!

Napisano: 11 Apr 2017 22:42

Trenutno razmatram sledeće opcije :

https://github.com/justinwalsh/daux.io
https://readthedocs.org/dashboard/

Dopuna: 12 Apr 2017 0:33

Done.
Nije ni ovo rešenje koje mi omogućava da preko nekog editora radim to što želim ali je bolje nego da sam pravim sve od nule.
Ako instalirate daux, pratite ovo uputstvo :
http://daux.io/Getting_Started
Potrebno je da instalirate Php i Composer. Morate da promenite php.ini i da omogućite par ekstenzija.
Nakon toga jednom linijom gradite dokumentaciju.
Kreiranje fajlova podrazumeva da kreirate fajlove i foldere strukturno.

Za dokumentaciju koda ću videti da li mogu da iskoristim Daux.

Hvala

Dopuna: 12 Apr 2017 3:37

Okej, nakon što sam odradio mini tutorijal da se upoznam sa MD sintaksom, mogu vam reći da je ovo skroz gotivno rešenje.

Moram da preporučim i aplikaciju MarkdownPad 2, koja odmah prikazuje generisan HTML iz MD-a uporedo sa plain tekstom.

Znači sedneš i pišeš, vrlo jednostavna struktura itd.
Prezadovoljan sam.

• 1Ovo se svidja korisniku: Fil
  
  Registruj se da bi pohvalio/la poruku!

Napisano: 01 Feb 2020 9:24

Hteo sam da odradim neku dokumentaciju, međutim Daux ima neki problem sa novom PHP verzijom, pa trenutno razgledam MKDocs
https://www.mkdocs.org/#installation

Sviđa mi se. Jednostavan je za upotrebu i ima ugrađen server koji automatski primećuje promene i ažurira pregled.

Dopuna: 02 Feb 2020 2:27

Oduševljen sam. Jednostavna instalacija, jednostavna upotreba. Zabavno je čak

Ovaj live refresh je stvarno odličan.
Do sada sam dokumentaciju radio u MarkDownPad 2, pa to organizovao za Daux, međutim više nema potrebe za tim.
Ubacio sam dokumentaciju u VS projekat, menjam je tu i odmah na ekranu vidim sve izmene. Bez ikakvog dodatnog podešavanja posle osnovne instalacije.

Ima mnogo tema i opcija za proširivanje po želji.

Evo rezultata http://docs.digitalhamster.net/MumbleTriviaBot/
Ovo je third party tema za MKDocs

Jedna komanda i sve je gotovo, prebaciš na sajt i to je to.
Čini mi se da Daux ima malo više opcija za izvoz ali je nešto komplikovaniji jer zahteva posebnu strukturu. MkDocs sve to rešava jednim config fajlom u suštini :

nav:     - About : index.md     - Download & Support : DownloadAndSupport.md     - Interface:         - Main Window : Interface.md         - Trivia Library : InterfaceTriviaLibrary.md         - Open Trivia DB Importer : OpenTriviaDB.md     ... theme:     name: material     logo: 'img\bot128.png'     favicon: 'img\robot.ico'     palette:         primary: 'teal'         accent: 'teal'

Sve u svemu, preporuka od mene