Code Monkey home page Code Monkey logo

Comments (10)

stevedonovan avatar stevedonovan commented on May 29, 2024

It should happen automatically, when docs in Markdown format are converted (using ldoc.prettify). Is this perhaps a style sheet problem? You can adjust the colours if they're not showing up well.

from ldoc.

pronebird avatar pronebird commented on May 29, 2024

Does not happen for @Usage blocks. I tried to indent @Usage code, but it doesn't help.

from ldoc.

stevedonovan avatar stevedonovan commented on May 29, 2024

Ah, I see - yes, that sounds like a good idea. In most cases usage code is Lua, so there is no harm in prettifying all usage blocks.

from ldoc.

pronebird avatar pronebird commented on May 29, 2024

I'll send you a pull request soon with (optional) lxsh highlighting.

from ldoc.

stevedonovan avatar stevedonovan commented on May 29, 2024

That would be cool. I'm thinking of how best to indicate what language is to be used for a particular block. Currently in Markdown docs there's only a @plain directiive for switching off highlighting; it would be relatively easy to add support for other languages (particularly C/C++) in code blocks. Let me first add Lua support and I'll push that.

from ldoc.

Yonaba avatar Yonaba commented on May 29, 2024

About that, why not adding support for backticks, as with Github Flavoured Markdown (See Fenced code blocks) ? For instance, I am using them when writing snippets of code in most of my READMEs, so I won't have to change anything in the Markdown code and still use the same README to generate HTML with LDoc. Just asking, though.

from ldoc.

stevedonovan avatar stevedonovan commented on May 29, 2024

I like this suggestion, I find them easier to type myself and they are becoming a standard. Then it's very clear what the language is. However, how would that work with @Usage?

from ldoc.

pronebird avatar pronebird commented on May 29, 2024

I could not find any good gfm library for lua. Also, markdown & discount can mess around, I have very positive experience with gfm-like libs on node, smart libs like marked, but they are not available for lua :/

@Usage should take language argument somehow.

from ldoc.

stevedonovan avatar stevedonovan commented on May 29, 2024

Well, if you find such a thing (or do the translation from Ruby yourself?) then LDoc is happy to accommodate new format parsers. One of my collaborators likes Lunamark and has added support for it.

from ldoc.

pronebird avatar pronebird commented on May 29, 2024

Closing issue due to recent implementation of this task and lxsh introduction as well. Thanks @stevedonovan for your code merge mastery. There are some minor glitches in README.md converter, e.g. last new line in ``` blocks doesn't get trimmed and indentation is messed up if // comments used in c-code, I am not exactly sure whether it's lxsh problem or not. But this is the least that bothers me now and it works fine for @Usage blocks.

from ldoc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.