5
webketje
46d

Why, just why do 4k devs find this a good idea https://github.com/sindresorhus/.....

Don't get me wrong I respect this oss dev a lot, I just think readme's should be boring with the least distraction possible.

Comments
  • 0
    What's wrong with it?
  • 6
    @C0D4 The reason we use markdown is that markdown notation is the same as the intended compile result, which means that opening the file with notepad or nano just works. CSS doesn't work like this.
  • 2
    Respect the vibes
  • 3
    What triggers me most is the file called "README.md" but containing just HTML tags.

    I like the work of sindresorhus, but why are they doing this?!
  • 4
    This is cool as a random tech demo, but I seriously hope it doesn't catch on.
  • 2
    It's not a good idea and markdown parser should not even process HTML.
  • 1
    Octodroid can't display that crap. I'm fine with some minor demo html stuff or in static content generator articles (goal here is web content) but generally speaking use markdown syntax it's what is for and it's awesome.
  • 0
    I don't get yall's problem...

    markdown has been an all-time favourite for static site generators i.e. VuePress and Hugo just to name some.

    I find it hilarious that someone could get mad because CSS has been used inside Markdown lmao, because it "shouldn't be". Markdown is just a simple way of formatting content with large support on the web. What do you think GitHub, GitLab and a couple forums do with your Markdown? Yeah, transpose it into HTML. So why wouldn't you wanna have control over styling via CSS?

    Sorry, I really don't get the perspective. Guess this is a subrant then.
  • 0
    @homo-lorens And in order for that to work people built plugins for the editors mentioned lmao. Also... CSS already is parsed correctly inside Markdown (at least when viewing via VSCode). It's not standardized though since every piece of Markdown is usually transpiled into HTML.
  • 1
    @fuyukine There's gonna be a time when somebody carries it to a well known repository that'll cause a bit of inconvenience to the devs not using HTML renderer plugin. Some of us are still rocking raw vi ya know :)
  • 3
    @fuyukine I see you can't see the text from your tooling, but have you ever actually looked at a markdown document *without the plugins*? Because my point was that regular markdown _still_ looks similar to the intended meaning even _without_ the plugins. This is what CSS can't do. I didn't even know it was a VSCode-only thing, this proves my point even further. Markdown isn't code. Markdown is a standard of ASCII typesetting that allows tools to understand the intended structure of the text and render it in a prettier format. If you want nice results _after_ compilation, use fucking HTML with CSS, you can chuck a bit of damn JS in there as well while you're at it. Markdown isn't a language and shouldn't require any tool other than a Unicode capable text editor to read.
  • 2
    @fuyukine Also also markdown isn't exactly "made" to render. It's the closest you can get to parseable HTML-like structure while still maintaining readability in the source.

    That being said, a little eye-candy never harmed anybody.
  • 1
    @homo-lorens I can already see some JS based introductions to markdown. MDJS is a good one. But again that provides backwards compatibility to markdown by shoving all the JS in the bottom of the markdown.
  • 1
  • 2
    @fuyukine The problem is you need a bloody webbrowser and even then that might do stuff different. As I said my android GitHub tool can't display it at all!
    Markdown is a text format enhanced with semantics. Even without fancy "rendering" it's readable and easily edited without having to worry about DOM structure classes etc.

    You would feel just as raped if we would just put concatenated docx in all your .md files. You would need specific tools, can't read/edit that shit decently anymore, commits are polluted with semantics not just the modified text and it breaks your existing tooling (like static content generator).
  • 1
    @hjk101 Does the official GitHub app not support readme HTML rendering? That's quite strange
  • 1
    @homo-lorens It all started with badges I tell you. They have constantly been the bane of my existence. Just a fuck ton of image tags. At one point I found a readme with more than 40% README.md written just for the badges , images and license images.
  • 1
    @3rdWorldPoison Don't know. Didn't even know there is an official GitHub app. I've been using OctoDroid for years the official app was released this February. Never saw a readme that I could not read till this crap.

    Would not be surprised or mind if the app does not support html or does not render it well on mobile though.
  • 2
    @3rdWorldPoison yeah some repo's really abuse the badges, although some dynamically rendered badges for CI results and test coverage are quite useful. Still, those are embeddable with markdown, and they provide actual info.

    The point of my rant was that polluting markdown with inline svg and nested style tag, isn't worth the minimal (presentational) value. Just because you can (in a web browser), doesn't mean you should.
  • 0
    Storybook now also provides support for something called "mdx" (markdown with embedded React JSX components), but again, instead of polluting the markdown they could have used the <path/to/component/instance.jsx> link tag as a bridge and render the component if the link ends in jsx
Add Comment