Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lein-midje-doc will not run without option "plain" #1

Merged
merged 1 commit into from
Sep 30, 2013
Merged

lein-midje-doc will not run without option "plain" #1

merged 1 commit into from
Sep 30, 2013

Conversation

xsc
Copy link
Collaborator

@xsc xsc commented Sep 30, 2013

Just wanted to check your plugin out and since nothing was generated, even when I tried it with the lein-midje-doc project itself, I went on a (really small) expedition into your code and fixed this small bug.

Also, I'm really looking forward to some of the features on the wishlist, e.g. single-page generation, markdown rendering and themes. Great job so far!

zcaudate pushed a commit that referenced this pull request Sep 30, 2013
lein-midje-doc will not run without option "plain"
@zcaudate zcaudate merged commit b33b27f into zcaudate-me:master Sep 30, 2013
@zcaudate
Copy link
Member

Thanks! Is it working with colours for you though?

It's probably going to take a while before I get to all the features... the whole things a hack job... but I've been able to generate a whole bunch of documentation with the current version if you want more samples:

http://z.caudate.me/ribol/
http://z.caudate.me/ova/
http://z.caudate.me/cronj/

@xsc
Copy link
Collaborator Author

xsc commented Sep 30, 2013

No colors since pygmentize is not installed (or wasn't until now). Two things:

  • Shouldn't lein midje-doc once plain generate a document without colors? Currently, it doesn't if pygmentize is installed. The check should probably be (if (or (opts "plain") (not (check-pygmentize)) ...) instead of what it currently is.
  • plain does not escape the contents of the <pre> sections, so the browser will get confuzzled with things like:
...
  :title "<title>"
...

Chrome does e.g. not display anything after the above line, even though the HTML source is complete.

the whole things a hack job...

And a nice one at that! ;)

EDIT: Also, there seems to be an issue here where the branches of the if-statement are in the wrong order.

@zcaudate
Copy link
Member

yeah... you're right about that.. I was a little bit confused when I went over the changes... thats why I asked the question =)

Feel free to put in another pull request. I think you caught all the problems!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants