On Aug 10, 2010, at 10:53 PM, James Turnbull wrote:

> During this process we began doing a programmatic conversion of the
> Restructured Text output from the automatically generated documentation
> to Markdown.    The conversion process is less than perfect and some of
> the Markdown generated is not overly elegant - making some of our Docs
> pages ugly and hard to read.

I’ve noticed a couple of things related to in-line fixed-width text (or 
whatever you want to call the expected result of using back ticks in Markdown).

1) It looks like text enclosed `like this` is properly converted to <code>like 
this</code> on the back-end, but there’s no styling to set this text apart. (It 
should show up in a fixed-width font at the very least).

2) There are places where back ticks are missing and it causes problems. For 
instance, the page on templating suggests this command:

    puppet --configprint templatedir

I assume you’re running things through SmartyPants in addition to Markdown 
because the above is converted to:

    puppet –configprint templatedir

which will barf if you paste it into a Terminal and try to run it. :)

I suppose the second problem is exactly the type of thing you’re asking for 
help with, and if I get time I’ll try, but the first issue I think needs to be 
fixed in the CSS file(s) across the board.

Thanks.

-- 
Rob McBroom
<http://www.skurfer.com/>


-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Users" group.
To post to this group, send email to puppet-us...@googlegroups.com.
To unsubscribe from this group, send email to 
puppet-users+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/puppet-users?hl=en.

Reply via email to