Anis Kadri created CB-590:
-----------------------------
Summary: Update README.md
Key: CB-590
URL: https://issues.apache.org/jira/browse/CB-590
Project: Apache Callback
Issue Type: Task
Components: Docs
Affects Versions: 1.7.0
Reporter: Anis Kadri
Assignee: Michael Brooks
Fix For: 1.8.0
The README.md in the Generating documentation section asks to install markdown
via:
{noformat}
port install markdown
{noformat}
markdown does not exist in the macports
{noformat}
sudo port install markdown
Error: Port markdown not found
To report a bug, see <http://guide.macports.org/#project.tickets>
{noformat}
After installing Markdown.pl from
[here|http://daringfireball.net/projects/markdown/] and putting it my PATH I
get this exception when I run ./bin/generate
{noformat}
=> 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
{noformat}
I fixed this by adding this line to my joDoc perl script
{code}
$markdown_bin = "/path/to/Markdown.pl";
{code}
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
