Skip to content
This repository has been archived by the owner on Jan 23, 2022. It is now read-only.

External Examples #182

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

External Examples #182

wants to merge 2 commits into from

Commits on Sep 17, 2015

  1. External examples - adding support for external examples. 

    The idea is that writing <example> in the actual code is very clumsy and messy.
We'd rather have external files that hold the examples, and can even be run separately, without using any ngdocs compiler.

We incorporate those external examples using a hint in the documentation itself:

@external-example:some.example

This will look for a directory named 'example' inside another directory named 'some', under the base examples directory (which can be configured in the Gruntfile, and is named 'examples' by default).
Every file under that directory will become a <file> in the documentation.
The AngularJS module will have the name of the example, i.e. 'some.example'.

HTML files that are used this way can be real, full HTMLs.
The plugin will know to only take the <body> part and include it in the <file> section.
    @wolf-daniel
    wolf-daniel committed Sep 17, 2015
    Configuration menu
    Copy the full SHA
    a19068e View commit details
    Browse the repository at this point in the history

  2. Upgrade npm version.

    @wolf-daniel
    wolf-daniel committed Sep 17, 2015
    Configuration menu
    Copy the full SHA
    6d30782 View commit details
    Browse the repository at this point in the history