Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://github.com/dojo/dapi/wiki/Background below:

Background · dojo/dapi Wiki · GitHub

Dojo has long had an API viewer however the API viewer has in a sorts, been neglected and not fully documented or made clear to end users how to install and use for their own needs.

This repository aims to address this making it easier for end users to consume their own documentation and customise viewing of the API.

You will want to use this repository if:

• You want to host the Dojo API documentation yourself.
• You want to host and display your own API documentation as well as the Dojo API docs.
• You can't host a node.js app server to view API documentation.
  • dapi can generate static html so you can host the API documentation through a file server such as apache etc instead (without PHP or node.js).
• You want to brand the API viewer for your own needs, or even completely alter markup generation to something entirely different.

Workflow

The workflow for generating and viewing your own API docs (or just locally hosting the official Dojo API docs) should be clear to all users.

Typically in your Dojo source code (in modules) you write Dojo documentation comments (which is similar to JSDOC but is not the same format) to display API information. Another option to view the API information was to actually edit the API data source directly which the Dojo reference docs allude to but didn't entirely make it clear; essentially that meant editing the Dojo details.xml (or newer details.json) file, not including documentation comments in the module itself.

My opinion (and the opinion of others) is that it's best practice to add the documentation inline in the source code itself, the workflow is based on this pattern.

Your workflow for viewing API documentation should therefore consist of:

1) js-doc-parse:              --> exports details.json & tree.json
       |
      \ /                      
2) Copy files to dapi         --> dapi/public/data/{version}
       |
      \ /                      
3) Run dapi:                  --> app.js or spider.js

1. Generate a version of the API to be viewed which will generate details.json and tree.json files via Dojo's js-doc-parse
2. Copy these files to a version subdirectory of dapi (which is explained in Configuration). Create the directories if they haven't been created already
3. Run dapi according to your needs

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4