Coder Social home page Coder Social logo

Comments (7)

DavidOliver avatar DavidOliver commented on July 17, 2024

I can take a look at this soon.

from ex_doc.

josevalim avatar josevalim commented on July 17, 2024

Thank you @DavidOliver. However, if deemed too complicated, I'd say it is fine to not supported admonitions in .cheatmd. They are also not supported .livemd as well (as in: Livebook does not render them properly).

from ex_doc.

josevalim avatar josevalim commented on July 17, 2024

Hi @DavidOliver, just checking: is this worth investigating/addressing?

from ex_doc.

DavidOliver avatar DavidOliver commented on July 17, 2024

@josevalim Sorry for the delay. I've now refreshed my memory of the cheatsheet styles, and they do seem to deliberately take a simple approach and assume a limited set of elements. I get the sense that the limited support of features in cheatsheets makes sense given their purpose. (Semi-related, tabset content isn't included in the output HTML in cheatsheets.)

Perhaps we could update the intro paragraph of the Cheatsheet User Guide to:

This document is a cheatsheet on how to create cheatsheets. Cheatsheets are Markdown files with the .cheatmd extension which support a limited range of the ExDoc features. Refer to the source of this document.

from ex_doc.

josevalim avatar josevalim commented on July 17, 2024

@DavidOliver whatever you decide is fine by me. Could you please submit a PR with your proposed changes? :)

from ex_doc.

DavidOliver avatar DavidOliver commented on July 17, 2024

@josevalim, will do. I think I can improve on the wording I gave above.

from ex_doc.

davidsulc avatar davidsulc commented on July 17, 2024

Thanks for taking the time to look into it! 👍

from ex_doc.

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.