Comments (7)
I can take a look at this soon.
from ex_doc.
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.
Hi @DavidOliver, just checking: is this worth investigating/addressing?
from ex_doc.
@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.
@DavidOliver whatever you decide is fine by me. Could you please submit a PR with your proposed changes? :)
from ex_doc.
@josevalim, will do. I think I can improve on the wording I gave above.
from ex_doc.
Thanks for taking the time to look into it! 👍
from ex_doc.
Related Issues (20)
- Empty source AST HOT 6
- Heading with content `tooltip` is not visible HOT 1
- Truly light theme HOT 5
- Admonition does not work in Erlang @doc blocks HOT 8
- New ex_doc release
- Support blockquote highlighting for GitHub Markdown HOT 1
- Add syntax highlighting for JavaScript/TypeScript HOT 3
- links for otp apps' (gen_tcp/ssl) types use old format HOT 4
- Bullet list not displayed correctly HOT 4
- Better integrate Erlang/Elixir
- Mobile: Search bar is too sensitive to page scroll HOT 2
- Warn about docs for out-of-date versions HOT 1
- Odd Gradient with mobile breakpoint in light mode HOT 1
- feature request: Link to Anchor callback/function auto-links like with Modules and Extra pages
- Possible error when deprecating binaries path for assets HOT 4
- Failure to render links for specs when using Elixir 1.17 or later HOT 1
- No support for debug_info keys? HOT 1
- Search page shows no results even though autocomplete finds them HOT 1
- Signs in integer literals trigger warning HOT 3
- More explicit warning when type not visible because module is not visible HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ex_doc.