Details

    • Type: Task Task
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.7.0
    • Fix Version/s: 2.0.0
    • Component/s: Docs
    • Labels:
      None

      Description

      The README.md in the Generating documentation section asks to install markdown via:

      port install markdown
      

      markdown does not exist in the macports

      sudo port install markdown
      Error: Port markdown not found
      To report a bug, see <http://guide.macports.org/#project.tickets>
      

      After installing Markdown.pl from here and putting it my PATH I get this exception when I run ./bin/generate

       => Generating the Cordova Documentation for 0.9.2-en...
      ./bin/../lib/cordova/navigation_menu.rb:14:in `read': can't convert nil into String (TypeError)
      	from ./bin/../lib/cordova/navigation_menu.rb:14:in `initialize'
      	from ./bin/../lib/docs_generator.rb:86:in `new'
      	from ./bin/../lib/docs_generator.rb:86:in `after_jodoc'
      	from ./bin/../lib/docs_generator.rb:55:in `run'
      	from ./bin/../lib/docs_generator.rb:45:in `foreach'
      	from ./bin/../lib/docs_generator.rb:45:in `run'
      	from ./bin/../lib/docs_generator.rb:41:in `foreach'
      	from ./bin/../lib/docs_generator.rb:41:in `run'
      	from ./bin/generate:6
      

      I fixed this by adding this line to my joDoc perl script

      $markdown_bin = "/path/to/Markdown.pl";
      

        Activity

        Anis Kadri created issue -
        Michael Brooks made changes -
        Field Original Value New Value
        Status Open [ 1 ] In Progress [ 3 ]
        Hide
        Ben Clayton added a comment - - edited

        I have the same issue on Mac OSX 10.7.4.
        Where did you add the $markdown_bin line? I've tried adding it at line 35 but I still get the same error (path to Markdown.pl is definitely correct).
        EDIT: sorry, it does work. I'd used // comments rather than #. Thanks for reporting this (with the fix!).

        Show
        Ben Clayton added a comment - - edited I have the same issue on Mac OSX 10.7.4. Where did you add the $markdown_bin line? I've tried adding it at line 35 but I still get the same error (path to Markdown.pl is definitely correct). EDIT: sorry, it does work. I'd used // comments rather than #. Thanks for reporting this (with the fix!).
        Michael Brooks made changes -
        Fix Version/s 1.9.0 [ 12319551 ]
        Fix Version/s 1.8.0 [ 12319550 ]
        Michael Brooks made changes -
        Fix Version/s 2.0.0 [ 12318875 ]
        Fix Version/s 1.9.0 [ 12319551 ]
        Hide
        Michael Brooks added a comment -

        @Ben Thanks for leaving a comment. It's good to know that others are having this issue. After Anis reported it, I wasn't able to recreate it. However, I have an older Macbook that has been went through a few OS upgrades, so I may have some legacy paths / binaries hanging out.

        We're planning to rewrite the documentation generator, so I do not want to devote too much time to this issue. I've updated the README.md's installation steps and added a FAQ with Anis' suggested fix and a link to this issue.

        Show
        Michael Brooks added a comment - @Ben Thanks for leaving a comment. It's good to know that others are having this issue. After Anis reported it, I wasn't able to recreate it. However, I have an older Macbook that has been went through a few OS upgrades, so I may have some legacy paths / binaries hanging out. We're planning to rewrite the documentation generator, so I do not want to devote too much time to this issue. I've updated the README.md's installation steps and added a FAQ with Anis' suggested fix and a link to this issue.
        Hide
        Michael Brooks added a comment -
        Show
        Michael Brooks added a comment - Commit 91231e
        Michael Brooks made changes -
        Status In Progress [ 3 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Hide
        Andrew Grieve added a comment -

        I'm hitting this and adding $markdown_bin = "/path/to/Markdown.pl"; (with the correct path) didn't fix it.

        Show
        Andrew Grieve added a comment - I'm hitting this and adding $markdown_bin = "/path/to/Markdown.pl"; (with the correct path) didn't fix it.

          People

          • Assignee:
            Michael Brooks
            Reporter:
            Anis Kadri
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development