API documentation in WordPress

[PikaPower]

Ik heb graag jullie hulp nodig. Het volgende is het geval; ik wil graag op onze website de API documentatie plaatsen vanuit Github. En dat moet er dan ongeveer zo uit komen te zien: http://developers.seoshop.com/api

Ik heb me rot gezocht maar niet kunnen vinden Iemand die misschien hier een oplossing voor heeft/weet ?

[CH4OS]

Laden die niet gewoon de RAW variant in met een markdown parser erop?

Wellicht is https://apiary.io/ een optie? Ik kom genoeg sites tegen die hun API documentatie daarop zetten, of vergelijkbare diensten.

Of een van de alternatieven, aangezien Apiary in zee is met Oracle (en niet veel mensen blij zijn met Oracle): https://alternativeto.net/software/apiary-io/

[ Voor 77% gewijzigd door CH4OS op 09-01-2018 19:07 ]

[b2vjfvj75gjx7]

Lijkt mij ook een kwestie van je .MD file(s) inlezen (incl. markdown) en eventueel uitspugen via een plugin;

https://www.google.nl/search?q=wordpress+markdown+plugin

Uiteindelijk is het gewoon CSS en HTML wat je ziet... dus je kan ook de bestaande API documentatie inlezen en even voorzien van een 'API-achtige' styling.

[PikaPower]

We hebben alleen een tool nodig die de HTML-bestanden van `https://github.com/xxx/api` kopieert naar de directory voor `https://www.url.io/api/`. Geen aparte plug-in voor het genereren of opmaken van API-documentatie dus (want dat gebeurt al), maar een simpele synchronisatie.

misschien moet dit dan wel buiten wordpress om ?

[ Voor 8% gewijzigd door PikaPower op 10-01-2018 08:10 ]

[HollowGamer]

Genoeg tools voor beschikbaar, zoek maar eens op offline site downloader ofzo.

Verder snap ik het niet zo, want je loopt nu dus altijd achter op de documentatie.

[PikaPower]

HollowGamer schreef op woensdag 10 januari 2018 @ 08:12:
Genoeg tools voor beschikbaar, zoek maar eens op offline site downloader ofzo.

Verder snap ik het niet zo, want je loopt nu dus altijd achter op de documentatie.

Als het goed is niet, alles zou automatisch moeten syncen
de content en opmaak worden automatisch gegenereerd door ApiGen via commentaar in de PHP-bestanden

[DJMaze]

code:

$ ssh [e-mail]
$ cd /home/user
$ git clone github/.../api
$ ln -s public_html/api ../api

Ja, dat kan ook in PHP en Cron