Giter Club home page Giter Club logo

Comments (5)

stevedonovan avatar stevedonovan commented on September 25, 2024

The basic problem here is that this style isn't compatible with using Markdown, but it should work without Markdown. Let me check this. Perhaps we need an option to use Markdown for other parts of the project (readme, examples) but not for doc comments.

from ldoc.

stevedonovan avatar stevedonovan commented on September 25, 2024

Just to check: do you still have a need for Markdown in readme, but not in code comments?

from ldoc.

ToadJamb avatar ToadJamb commented on September 25, 2024

Yes. All my readmes these days are in markdown and I would like very much to structure my comments as outlined in the original post. The only question/concern would be that there is other Markdown structure/functionality that is currently "free" that would be lost. Without knowing how tightly coupled the code comment output is to Markdown, that is difficult for me to gauge.

from ldoc.

stevedonovan avatar stevedonovan commented on September 25, 2024

Latest push does want you want - it was fairly straightforward! Use of Markdown for doc comments can be switched off using plain=true even if you have format=markdown etc.

from ldoc.

alerque avatar alerque commented on September 25, 2024

Long since fixed.

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.