LegacyCollector

Home | Legacy Firefox Extensions | Content Policy | Contact

MDN Interface Documentation Generator

Author(s):



This add-on is designed to remove a lot of the heavy lifting from creating interface documentation for MDN - developer.mozilla.org

To update existing documentation I follow these steps:
  1. Start running mdni for the interface, this process takes some time so you can continue with the next steps.

  2. Copy the source of the existing documentation to a text editor.

  3. Find and replace '{{template.' with '{{', '.28.29' with '()', sometimes there will be excessive or unnecessary  , either remove them or replace with a regular space.

  4. When mdni has finished, copy the generated content.

  5. Paste the generated content into the source of a page on MDC, click the source button twice (this will format the source to make comparison easier).

  6. Copy the source of the generated documentation to a text editor and save.

  7. Use your favourite diff viewer (I use Meld) to move the relevant information to the generated content.

  8. Replace the original documentation with the generated documentation.

  9. If necessary make changes to the tags of the page.

  10. If necessary move the page to ../XPCOM Interface Reference/ .



Download files:

mdn-interface-documentation-ge-0.11.xpi
mdn-interface-documentation-ge-0.13.1-signed.1-signed.xpi
mdn-interface-documentation-ge-0.14.3.1-signed.1-signed.xpi
mdn-interface-documentation-ge-0.14.4.1-signed.1-signed.xpi
mdn-interface-documentation-ge-0.14.5.1-signed.1-signed.xpi




This page is part of the LegacyCollector website.
Disclaimer: All material on this site is property of their respective owners and available under
open licenses to the best of our knowledge. If you are an author and would like anything removed,
then please write an e-mail to legacy [at] collector dot org.