it-swarm-eu.dev

Come viene generata la documentazione di Joomla Issue Tracker?

Qualcuno qui può condividere un po 'di luce su come sono stati realizzati questi documenti Joomla

http://issues.joomla.org/documentation/

So che i documenti vengono estratti dai file MD di Github ma se qualcuno potrebbe spiegare il processo poiché non trovo esattamente come.

4
Dan

La documentazione è memorizzata nel nostro repository JIssues GitHub in formato Markdown per una facile elaborazione e contributo.

Per visualizzare i documenti sul sito , utilizziamo un script della riga di comando che analizza la cartella, analizza il documento Markdown in HTML tramite l'API GitHub e il rendering è archiviato nel database.

7
Michael

Quindi il tracker JIssues utilizza Joomla Framework - quindi alcune delle dipendenze di github sono raggruppate in via composer da https://github.com/joomla-framework/github-api

Il codice specifico dai file md qui https://github.com/joomla/jissues/tree/master/Documentation

Il codice che li afferra per il rendering è qui: https://github.com/joomla/jissues/tree/master/src/App/Support (l'albero dei file con il plugin jQuery tree si trova nella controller Filetree.php ecc.)

E infine il rendering è in un twig trovato qui: https://github.com/joomla/jissues/blob/master/templates/support/documentation.index.twig

5
George Wilson