Skip to content
gen-1
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
app
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Yuidork

View YUIDoc (and probably JSDoc) documentation generated realtime from any GitHub sources.

Allows viewing docs for any branch/tag/commit, does not require generated docs to be uploaded.

Work in progress! See the roadmap below.

Live demos:

Roadmap

Legend

-- not implemented yet, planned
🔘 -- in progress (leaf) or partially implemented (branch)
-- implemented
-- blocked, has to be figured out

  • 🔘 Parsing
    • 🔘 Models and relationships
      • Version (git tag/branch/commit/etc)
      • File
      • Module
      • Class
      • Class Item
      • Namespace
      • Project (need a better way to present project info)
      • Element (don't know what that is, need a reference project)
      • For (don't know what that is, need a reference project)
    • Parse YUIDoc JSON format and populate store
    • Generate documentation live for any project on GitHub
      • Port YUIDoc.DocParser (aww yiss! 😎)
      • Custom AJAX service
      • Loading screen with stages display
    • Display documentation from existing JSON files
  • 🔘 UI
    • Menu
    • Module page
    • Namespace page
    • 🔘 Class page
      • 🔘 Basic class info
      • Class Items component (navigate/filter class items)
      • Class Item component (method/property/event)
    • Reload model when changing URL params
    • Versions switcher
    • Project switcher
    • Search options
    • Linking to viewed project on GitHub
    • Linking to viewed project's website (from config)
  • 🔘 Configuration
    • 🔘 Source
      • Via query params
      • Via dotfile
    • Options
      • Versions
      • Extensions
      • Path to JSDoc's data.json
      • Project info: name, desc, URL
      • Disable/enable project switcher
      • Hide menu sections
  • Styling
  • Authentication
    • GitHub auth
      • Viewing private repos
    • Error handling
      • API limit
      • Network failure
  • 🔘 Advanced features
    • Caching
      • Basic caching
      • Background SHA fetching and comparing
    • 🔘 Parsing docs from file system
      • Figure out how to serve and access files on disk
      • Implement
      • Document
      • Live-reloading (would be a fantastic to have, but too tricky to implement)
    • Cross-linking
  • Some tests maybe
  • Document with YUIDoc :trollface:
  • Support JSDoc (need to figure out how different YUIDoc and JSDoc formats are)

Project structure

Yuidork is distributed as an Ember addon, you can use it to build your own app or to include documentation into an existing Ember app.

But the Yuidork addon also bundles a dummy app which aims to be a universal and fully functional YUIDoc@GitHub viewer.

License

This software is free to use under the MIT license. See the LICENSE file for license text and copyright information.

Includes code ported from YUIDoc (Yahoo Inc. BSD license).

This software tries to adhere to the YUIDoc format, but it's not endorsed by or affiliated with Yahoo or YUIDoc.

The dummy app uses Fugue icons by Yusuke Kamiyamane (Creative Commons Attribution 3.0 License).

About

View YUIDoc docs for any project and branch/tag/commit fresh from GitHub

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published