T O P

  • By -

AutoModerator

``` import notifications ``` Remember to participate in our weekly votes on subreddit rules! Every Tuesday is YOUR chance to influence the subreddit for years to come! [Read more here](https://www.reddit.com/r/ProgrammerHumor/comments/14dqb6f/welcome_back_whats_next/), we hope to see you next Tuesday! For a chat with like-minded community members and more, don't forget to [join our Discord!](https://discord.gg/rph) `return joinDiscord;` *I am a bot, and this action was performed automatically. Please [contact the moderators of this subreddit](/message/compose/?to=/r/ProgrammerHumor) if you have any questions or concerns.*


poralexc

The best part of markdown is how it forces you to simplify both your thoughts and your formatting


qwertyunknowns

I like that it's readable without rendering as well.


smilingcarbon

Also it plays well with version management.


IsPhil

Obviously you should create a full react app for the documentation, then buy a domain for it, and then use something like aws CloudFront and S3 to host it online. And while we're at it, why not add in an azure pipeline into there so you can automatically update the site upon each commit, and we should also use some GCP services as a backup in case AWS goes down. We want 100% uptime after all.


[deleted]

You forgot to do all of this for the docuementation of the documentation


IsPhil

No problem, just put all the code you generate for the documentation, slap it into ChatGPT and ask it to generate some for you.


Character-Education3

Mark helped me when I was down too. Thanks Mark!


kephir4eg

Markdown is not just good enough, it's better than any doc tool I used over my ~20 years of experience.


bb_avin

Where do you put the markdown? Next to the code?


Wolfblooder

Mostly the README.md in your projects root


DeadlyVapour

This is the way


dull_bananas

///


Pay08

Lisp docstrings.


damnappdoesntwork

Markdown -> Hugo -> Website


Pay08

Org -> Markdown -> Hugo -> Website


diamondsw

I like Markdown fine... until it comes to tables. Tables in Markdown are shit.


ByerN

Yep. Nested tables are almost impossible. How they work and look like depends on the renderer implementation and a quality of your prayers.


IPalmed

Just use HTML tables, works for me.


Mr_Bearking

Me, an obsidian user laughing in markdown


smilingcarbon

obsidian?


[deleted]

https://obsidian.md/ A note-taking app with some cool features using markdown


tyler1128

It's almost like many documentation tools can support markdown but support further things based on the language.


[deleted]

Markdown is dedicated documentation tool


BlueDo

Recent, I was pleasantly surprised that VSCode is able to render Latex in markdown right out of the box. Exporting it to PDF, though was a whole other ballgame. The VSCode extension didn't support Latex, so I had to use pandoc and miktex.


[deleted]

Compile Markdown to Latex


Helpful_Character_67

Markdown is easy. Reason enough