Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Remove GitHub format from code blocks from documentation index file #289

Closed
fabiopelosin opened this Issue · 9 comments

2 participants

@fabiopelosin

Appledoc markdown parser doesn't like code blocks where the language is specified (GitHub flavor). We have two options regarding this:

  1. Use a temporary file where we replace code blocks from this:

     ```ruby
     ```
    

    to:

    ```
    ```
    
  2. Open a ticket in appledoc or in one or in its markdown parser to handle the issue directly.
@goonzoid

I'd say it would be much nicer if we can get this fixed in appledoc; having temporary docs files about just because of this issue would be a shame I think.

Happy to take this on and try and talk to the appledoc guys about this if you guys agree that's the best course.

@fabiopelosin

@willpragnell sounds great!


This is an example of the issue from ConciseKit

@goonzoid goonzoid was assigned
@goonzoid

Thanks. I'll have a closer look at it before I raise an issue over there on the appledoc repo.

@goonzoid

Of course, even if they are happy to make this change, it could take them some time. How hard do you think it would be to implement a temporary fix that we could revert later?

@fabiopelosin

Of course, even if they are happy to make this change, it could take them some time. How hard do you think it would be to implement a temporary fix that we could revert later?

I don't think it is hard, but I think that it is better to hear what is their opinion about this issue before considering alternatives.

@goonzoid

tomaz/appledoc#221

Let's see what they say :)

@fabiopelosin

This will be fixed by appledoc 3.0. Lets close the issues as it doesn't depends on us anymore.

@goonzoid

This will be fixed by appledoc 3.0. Lets close the issues as it doesn't depends on us anymore.

Damn, you beat me to it :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.