Fix/Improve Live Examples

wingedfox / dgeni-alive

Live docs on top of dgeni documentation generator

MIT License

26 stars 14 forks source link

Fix/Improve Live Examples #29

Closed nhorvath closed 7 years ago

nhorvath commented 7 years ago

Fixed live examples launching.
Fixed dgeni-alive running at all without jsx.
Fixed docs area was using guide in a few places
Ported Plunker launcher from AngularJS project dgeni to dgeni-alive.
Updated README with setup instructions for live examples.
Added iframe-resizer (https://github.com/davidjbradshaw/iframe-resizer) to automatically resize live example content frames

wingedfox commented 7 years ago

Hi Thank you for the PR. I still have no time to update dgeni and dgeni-packages and fix tests, I'd appreciate your help on this. I'll review other changes next weekend.

nhorvath commented 7 years ago

I started looking into the unit tests and I'm not sure how to fix them. Something has changed between 0.4.2 and 0.4.9 that breaks them, unfortunately in that span of time they switched dgeni to typescript so just looking at diffs is not helpful. I sent an email to the maintainer of dgeni in hopes he could point us in the right direction. It's strange that everything seems to work fine despite the failing tests.

petebacondarwin commented 7 years ago

@nhorvath - the reason for the failing tests is that the website package relies upon the navigation and search packages, which in turn depend upon processors that are defined in the dgeni-packages/jsdoc and dgeni-packages/base packages.

I don't know why this passes with earlier versions of dgeni.

In any case the fix is simple enough. Just add jsdoc-ext as a dependency of the search and navigation packages. For example:

var Package = require('dgeni').Package;
var path = require('path');

/**
 * @dgPackage search
 * @description Package maintaining search index processing
 */
module.exports = new Package('search', [require('../jsdoc-ext')])

// Add in the real processors for this package
.processor(require('./processors/search-index'))
;