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

doc: enable code syntax highlighting #23627

Merged
merged 1 commit into from May 2, 2017
Merged

doc: enable code syntax highlighting #23627

merged 1 commit into from May 2, 2017

Conversation

alexeymuranov
Copy link
Contributor

Use "fenced" code blocks to enable syntax highlighting in Haskell documentation haskell.md. Try to improve other markup and formatting.

@mention-bot
Copy link

@alexeymuranov, thanks for your PR! By analyzing the history of the files in this pull request, we identified @mboes, @peti and @vcunat to be potential reviewers.

@FRidh
Copy link
Member

FRidh commented Mar 8, 2017

Note that this isn't Markdown anymore but GitHub Flavored Markdown.

I hoped we could get syntax highlighting in the eventual manual as well by indicating the source is markdown_github. After fixing some small issues I got it to build, but unfortunately the syntax isn't highlighted. Checking the xml it seems a language is passed to programlisting so I suppose we need to fix the stylesheet.

@peti
Copy link
Member

peti commented Mar 9, 2017

That Markdown documented is targeting pandoc for conversion into Docbook so that it can be included in the Nixpkgs manual. Displaying that document in Github would be a nice feature, of course, but only if the Docbook output doesn't suffer because of it.

@FRidh
Copy link
Member

FRidh commented Mar 9, 2017

@peti Absolutely. Last I checked this PR (there's also one for Python #23535) didn't affect the manual in any negative way.

Use "fenced" code blocks to enable syntax highlighting.  Other markup
and formatting.
@alexeymuranov
Copy link
Contributor Author

No more merge conflicts.

@FRidh FRidh merged commit 84b1643 into NixOS:master May 2, 2017
@alexeymuranov alexeymuranov deleted the haskell-doc-markdown branch May 2, 2017 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants