Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

MooTools documentation helper

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 library
Octocat-spinner-32 sources
Octocat-spinner-32 tests
Octocat-spinner-32 tools
Octocat-spinner-32 CHANGELOG.md
Octocat-spinner-32 LICENSE.md
Octocat-spinner-32 README.md
Octocat-spinner-32 build.xml
README.md

MooDocs - Coda Plug-in

This plug-in for Coda creates a MooTools Docs like documentation template for MooTools classes.

After getting mixed results with Auto-doc generators, I finally settled on creating documentation separate from the source code using Markdown syntax for readability and ease of use. Check out MooTools’ documentation at their GitHub repository for the general style.

Documenting “by hand” can be quite tedious so I wrote this plug-in that parses MooTools Classes and generates a ready-to-fill Markdown formatted template. Pair it up with the Markdown plug-in and you can crank out ready-to-style HTML documentation for MooTools Classes in no time.

Features:

  • Written for PHP 5.
  • Parses source code for MooTools classes and generates a ready-to-fill Markdown formatted template.
  • Library can be re-purposed for other systems.

Requirements:

  • Coda 1.6.1 or later
  • PHP 5.2+

Installation:

Get the plugin by either:

* Downloading zip-file and unpacking.
* Copy/Export the SVN tag.

Double-click the .codaplugin package (Looks like a Lego sprouting leaves).

Restart Coda if updating from previous version.

Something went wrong with that request. Please try again.