4

Can anyone here share some light on how these Joomla docs were made

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

I know that the docs are pulled from github MD files but if someone could explain the process since I am not finding exact how to's.

  • I could be wrong, but I think they are using the Github library scripts that come packaged with Joomla, which you will find under root/libraries/joomla/github. A jQuery Tree plugin is also being used along with some Ajax which loads the subdirectories/files upon clicking a category. – Lodder May 6 '14 at 11:09
  • @Lodder It's using the framework - not the CMS – George Wilson May 6 '14 at 12:04
7

The documentation is stored in our JIssues GitHub repo in Markdown format for easy processing and contributing.

To display the docs on site, we use a command line script which scans the folder, parses the Markdown document into HTML via the GitHub API, and the rendering is stored into the database.

5

So the JIssues tracker uses the Joomla Framework - so some of the github dependencies are bundled in via composer from https://github.com/joomla-framework/github-api

The specific code from the md files here https://github.com/joomla/jissues/tree/master/Documentation

The code that grabs them for rendering is here: https://github.com/joomla/jissues/tree/master/src/App/Support (the file tree with the jQuery tree plugin is in the controller Filetree.php etc.)

And finally the rendering is in a twig template found here: https://github.com/joomla/jissues/blob/master/templates/support/documentation.index.twig

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.