lonnieezell / Bonfire

Jumpstart your CodeIgniter web applications with a modular, HMVC-ready, backend.
http://cibonfire.com
1.39k stars 524 forks source link

Error parsing 071 and 072 md files in docs #1182

Open buzkall opened 9 years ago

buzkall commented 9 years ago

When loading the md of the 071 or 072 versions (url /index.php/docs/developer/upgrade/071), the Markdown extender helper finds a problem with the * used in the tables.

For example

            <tr>
                <td>activity_* (activities module)</td>
                <td>activities_*</td>
            </tr>
            <tr>
                <td>db_* (database module, CI db_* entries remain the same)</td>
                <td>database_*</td>
            </tr>

gets transformed into:

    <tr><br />
        <td>activity_* (activities module)</td><br />
        <td>activities_<em></td><br />
    </tr><br />
    <tr><br />
        <td>db_</em> (database module, CI db_* entries remain the same)</td><br />
        <td>database_*</td><br />
    </tr><br />

And throws the exception: "String could not be parsed as XML"

This can be fixed using \ as scape character prior to all the *

mwhitneysdsu commented 9 years ago

As far as I can tell, this fix only works properly with the MarkdownExtra driver. The MarkdownExtended driver will not display any errors, but will also not display the tables. The Markdown driver will still error out. The Parsedown and LeagueCommonMark drivers will display the backslash.

GitHub seems to display every other asterisk: https://github.com/ci-bonfire/Bonfire/blob/develop/bonfire/docs/upgrade/071.md

Similar errors lead to implementing the LeagueCommonMark and Parsedown drivers in the first place, but the MarkdownExtended driver was kept as the default for legacy reasons. We may need to switch the default to Parsedown, or find another fix for these issues in the documentation.

Of course, this is complicated by the fact that 0.7.2 is the earliest version that includes the Parsedown driver and the instructions to configure the CommonMark driver.