*In a team meeting*

Me: *happily jotting down notes in markdown*

Other guy: "Dude what are you doing? Pay attention."
Me: "Umm... I'm taking notes?"
Other guy: "But why does your MS Word have black background?"
Me (a bit lost): "Umm... That's not Word. That's my text editor."
Other guy: "Alright... But how do you convert your notes into Word then?"
Me: "... I don't."
Other guy: *stares at me*
Me: * stare back*

It was a nice conversation.

By playing with Facebook source code in browser, you can enable GIF and Markdown, Tip Jar & many more options in comments.

Guys, you know what would be a fun feature for devRant?

Markdown!

@dfox can we have markdown support, can we? pretty please :)

tl;dr I need ideas on how to warn the next dev(s) that the company is a dumpster fire.

------

For the past week (actual time: three days) I've been writing documentation for work, since there isn't any. It's been okay, I guess. Certainly more interesting than anything else I've done at work in months.

I'm up to 10k words / 67kb of markdown, and I think I'm done. I could easily write another 30k words on everything, but I just can't care enough.

However, what I do care about is warning the next dev(s) about how terrible the place is to work, so I want to add little references or hints or other such things to my writing. To complicate that, there's a contractor dev who said he will edit the document to strip out my commentary and make it "friendly" for the next person. (I can kind of see why: I've been quite honest about the situation of everything, and it's pretty dire. If they read it as-is, they might just walk out the door. I certainly would have.) I'm also going to commit it to the repo, and afaik he doesn't have push rights, so he can't force-push and remove it. (and a force-push by someone else, adding my documentation immediately after I leave... that would be pretty fishy, too.)

Anyway, at someone's suggestion, I added a "three envelopes" reference in the access phrase generator section. I also wrote "Promises made outside of ES6 will not resolve" -- in the warning section of a document almost entirely about Rails. (because the boss has broken every single promise he has ever made me.)

What other hints and subtle warnings could I add?

(And hurry: tomorrow is my last day! ;3)

It's already one of those days and it's only 10am

devRant should support markdown or at least basic code syntax highlighting

I love to take notes in markdown format. I use markdown for almost anything. I even write quiz for my students in markdown.

It is really painful to copy-paste so many questions & answers into moodle. To be honest, I hate moodle UI. But it is the most popular and easiest solution for e-learning.

So I spend some minutes to curse moodle, 2 hours to build a program to convert markdown into xml. And another 1 day to make LaTeX and image works.

I still hate moodle UI. But at least I don't need to deal with it for a long time. Just import the xml, create the quiz, and done :)

Ah, the program was written in Python. I really miss the old time when Python was cool, and javascript was nothing without JQuery....

No promise, no callback, just code it and run it :)

My classmate sent an email to our teacher with a markdown file.

The teacher response "how do I open a .md file"

*Big big facepalm"

@dfox
!rant, it's the Feature request

Possibility to post `a code snippet with monospaced font` would be usefull.
Or even
```
def multiline_code():
from 2 to Inf:
"Lines of code"
```
Sth like in markdown.

When people don't use markdown to format their code in forums 😡

devRant feature idea: Text formatting in Markdown. This is a community for developers, after all.

Dear devRant,

I know you will hate me if I do this, so please set me straight,

I have urges...

Urges to create my own, fucked up flavor of markdown....

and worse yet.....

to make it a JavaScript templating engine.................

and publish it to NPM......................

I know you can do it. You can stop me before I commit this atrocity.

Instead of using OneNote, Evernote, etc I'm thinking of using a git repo where I would write notes, save bookmarks, links, information, everything with markdown.

And you thought your markdown based Wiki was going to change the company...

Idea: a markdown editor called WRITEME

Using 10% React with the rest in Jquery. Importing a giant legacy CSS blob in a newly made SCSS file. Two thirds of the API documentation in docblocks, the rest in Markdown files. Half of the repositories in Github, the other half in Bitbucket. The root of every project littered with ymls and jsons and readmes of stupidly named tools no one has ever heard of.

Fuck your partial refactoring, fuck your little experiments, fuck all this half work. I'm so done with this shit. 😡

Let me ask you something: why do most people prefer ms word over a simple plain text document when writing a manual. Use Markdown!

You can search and index it (grep, ack, etc)
You don't waste time formatting it.
It's portable over OS.
You only need a simple text editor.
You can export it to other formats, like PDF to print it!
You can use a version control system to version it.

Please! stop using those other formats. Make everyone's life easier.

Same applies when sharing tables. Simple CSV files are enough most of the time.

Thank you!!?!

### Should `markdown` be available in posts?
- [X] Yes
- [ ] No

Code block markdown in devrant? Would be nice 😊

DevRant! Please allow markdown; see photo below.

Talked with my boss about documentation for projects in markdown instead of (shiver) MS Word. My boss laughed after I explained what mark down was and said that she did not want a world where we had to edit text files all day.

Wait? What do you think programming is?!?

Also Word is basically a text file with tons of proprietary bloated junk on top. Any “feature” it has is not needed.

What do you use for resume (CV) and why?

Word (gdocs or libre)
LaTeX
Markdown
Jsonresume schema
Something else?

Also how does that work form a maintenance standpoint?

For a social platform for devs, I'm surprised there isn't support for `markdown`

Should I bother with LaTeX? I've been fine with Markdown until now, but lately I've been facing an inferiority complex about it lol

I rewrote my static website generation from jekyll to custom python code over single night.
Literally all jekyll plugins I use including seo, rss, syntax highlighting inside markdown content, sitemap, social plugins, css sass, all of it.
Now it’s around 400 lines of python code that I understand completely. I didn’t touch any existing templates and after comparing output I got even better results now and it’s working faster.
I skipped drafts as I don’t need them now.

Why ? Cause now I can make better generator for my side projects that can include some partial website generation, better modification and date handling, tree structure, etc.

What I will do now is that I will parse bunch of content to create markdown files that will be sucked by this generator to create static web pages that will flood internet lol.

Still I didn’t believe it was possible to rewrite all of it so quickly. I sit yesterday around 4pm and finished around 6am.
I started thinking that maybe I am crazy and no one can help me.

I spent a *very* long time trying to work out why my README file wasn't formatting....

It didn't have a .md extension.
:/

Coworker starts to write project documentation in Word (y)
"Markdown is too ugly and hard to use"

Physics class, groupwork

Me: *Writing a protocol in Markdown and LaTeX*
Partner: Are you currently using Excel?
Me: "No"
Partner: *yells* We need a new computer!

~~rant~~
Coding a Twitter bot at 5:43am

Using Markdown since 2 years and I didn't know that you can add 2 spaces at the end of a line to force a line break....
I've always added <br> or hit enter twice to do that. Wow

I’m slowly starting to run most of my daily operations & programming in Visual Studio Code.

Here’s an example of me working in markdown files for one of my GitHub projects...directly in VS Code with live preview 👏.

// Feature Request START
Is it possible we can have some kind of markdown on posts and comments? Maybe not bold or italic, but because of the target of the app, some kind of one-line and multi-line code blocks that highlight from other text (for example: having a gray background, using a consolas font, etc)
// Feature Request END

Anyone else been lightly formatting rants and comments with **markdown** hoping for it to be implemented?

_I know I have_

So, when can I start using GitHub-flavored markdown on my devRant posts?

Omg I just realized there is no code highlighting here!
`// @TODO: Please add this... `

Handed off a Markdown presentation to the marketing dept to add some pizzaz too---just to see what happens.

My bet is that they'll redo it all in PowerPoint. Or fire me. Latter is the lessor of two evils.

Is making documentation in markdown recommended or word/other editor?

I also need to put some pics and codes.

Is there anything uglier than XML documentation comments? The signal to noise ratio is appalling, like an exercise in redundancy for the sake of redundancy.

/// <summary>
/// Initializes a new instance of the <see cref="CipherInfo"/> class.
/// </summary>
/// <param name="keySize">Size of the key.</param>
/// <param name="cipher">The cipher.</param>
public CipherInfo(int keySize, Func<byte[], byte[], Cipher> cipher)
{ ... }

Compare that to the equivalent markdown documentation comments:
/// Initializes a new instance of the <see cref="CipherInfo"/> class.
/// ##Parameters
/// - `keySize` - Size of the key.
/// - `cipher` - The cipher.
public CipherInfo(int keySize, Func<byte[], byte[], Cipher> cipher)
{ ... }

Feature Request:
Can we have markdown formatting in rants / comments?

I am so mad, I have no words for how fucking much I hate ever having to work or pass work to other incompetent developers or teams, what a fucking waste of time and resources.

After handing off the frontend - for the client to find some team, that would do it in the short time and budget he needs (multiple developers, more fast, much good), he found a team that seemed to be alright for the job and seemed alright to me too, now maybe a month or two later, the client contacts me, that they fucked something up and if I could talk to them.

The email I then received from them seriously made me speechles, mad and sad, all at same time, I spent multiple upon multiple hours, getting a very good readable documentation up (markdown with TOC, properly rendered headers, bulletpoints, all that shit), with all files, all services used, all credentials, even converted all ssh keys into putty ppk format, in case the developers are using windows and are too dumb to do it themselves, nginx configs, it had seriously everything, even too much to list.

They somehow managed to fuck up the entire server, while attempting to "add ssh keys themselves", EVEN FUCKING THOUGH I have included all the keys they need, all the hosting credentials, everything, yet they decided to fuck with shit themselves and completely annihilate the server in the process (HOW?!), so not even the webserver works anymore.

I am fucking speechless, I made it so fucking easy to gather all info and files they need, all properly put into well named folders, along the documentation in an archive and they somehow managed to nuke the fucking server, while attempting to add ssh keys?!

If you don't know how to config a server, then don't fucking touch it and just use everything, that got served to you on a fucking silver platter.

---

I'll just instantly answer the most annoying comment, that somebody could come up with: "why didn't you do it yourself?"

Because in a perfect world, a fully managed team, can do much more than a single developer can, especially in the same timeframe and from what I heard of said client, atleast they did something in terms of developing the system. (which surprises me, considering it's the same people that nuked a server, while trying to add ssh keys)

For some reason the backend kept throwing errors when I tried to save a long string containing markdown. Initially I assumed I must be escaping things incorrectly but that all looked fine. Asked the backend guy to take a look.

Turned out that in order to count the number of words they were using a regex, which seems fine, unless you construct the regex out of my string and run that over the word count regex... 🤔

If you want developers to track of their hours (for grants etc) then that is fine.

If you require them in a to be in a markdown file in a repository then you are fucking up.

If you won’t pay for any quality time tracking software for your developer then you are an idiot!

devRant posts should support markdown.
Don't you agree?

How are people writing documents/reports? Markdown/Latex in your fav editor and export to PDF? Word? Pages? Libre Office?

I use Markdown, via VSCode, Bear, iA Writer, Marked and then push to PDF. If I have to, then export to DOCX.

adding code blocks to markdown exists for a reason 🤦‍♂️

Can't we just write rants in html? I mean I'm enjoying devRant really well so far but adding html tags and so would make me love it here even more

@dfox Can we haz markdown support for code snippets, please?

Just an suggestion. It has 90% possibility that this is a repost, but...

Can we have the post rant/comment to markdown? So that we can make the editor to markdown and view the rants in markdown.
Doesnt really need to be implemented though.

Slack markdown is different than Discord markdown >:(

@dfox (this might not be the correct way to tag here, but we'll see once I post)

A few suggestions:

1. Being able to move between day, month etc. by swiping left or right

2. A web interface (to rant from a laptop/desktop)

3. Link "framing" (a-la WhatsApp, messenger, where links get a frame with a picture and description)

4. basic markdown (bold, quotes, etc. a-la Reddit. this might exist but I haven't run into it, and if it does maybe a preview window for the result would be helpful)

Really like the app, cheers!

Hey everyone!

I'm on the hunt for new and exciting languages!

I'll state the ones I already know:
Python, Haskell, C(++), C#, Java, JavaScript, Ruby, Rust, Lua, about every kind of Basic, some branches of Lisp, BrainF**k, assembly, Octo (Chip-8) and GML(basically JavaScript).

I've also learnt some styling languages:
Html, CSS, Markup and Markdown.

Some misc languages too: Regex and a runny bit of the Wolfram Language.

Also I'm kind of limited to Windows, Linux and Android, as I do not own any Apple hardware except I have access to an old iPad, so are languages like Swift still good?

Thanks!

At what point is coding not coding anymore. When are you not considered a programmer?

Level 0 - Online Website Creation Tool
Level 1 - Programs that generate static HTML from markdown
Level 2 - Bootstrap
Level 3 - Using a JS framework
Level 4 - Using HTML and CSS (from scratch)

Anyone happen to know any markup language for generating HTML? It should be simple to use, but more layout oriented than markdown

Some cheapskate insists on writing a guide to selfhost <software> on Heroku and wants to add it to the official documentation, promising to maintain it (since none of the other devs are using or planning to use Heroku). I volunteer to give them a chance on grounds of it being high quality and maintained by that person in the future which they both promise.
Our docs are written as markdown files on github.

So here we go:
Starts a pull request: uploads their """guide""" as a docx. The content is completely unformatted, basically just an enumerated list.

Tell them to format it as markdown, suggest using github gists.
They go ahead and copy pasta their unformatted list into a gist.txt "allright i made it into gist for ya"

Tell them that they did not format it as markdown.
"sorry updated it in markdown :P"

I look at the file, it is still raw text in a gist.txt. Maybe a bit more spaced out, not that I would care to notice any changes at this point.

Tell them it is still not markdown and link them to a perfect example of another guide that takes advantage of code fragments for commands etc and is properly rendered since it uses .md

"I updated it to the markdown this time XP Can you give me some suggestions on how it looks?"

"How it looks"... "how it LOOKS"... I click the link for the 5th time and IT IS STILL JUST A RAW FUCKING GIST.

Jfc that person has some serious reading/thinking disability. To imagine them to be proactively keeping their guide up to date in the future is absolutely impossible. At that point I pulled out my support for the request since it was already taking more effort to even get a readable version of guide than I estimated for the whole process of adding it.

Oh, and one of the steps originally suggested in the """guide""" was adding the credentials file into the vcs.

My Last few days:

Working on a new project I started few days ago. Decided to push to GitHub.

Working on setup python script a this project requires a little work to get up and running

Working on markdown files and docs.

Moves to working on the GitHub page.

Now I am working on a website for a project that isn even 10% done.

would you guys like to see a blogging network?

it will
- be similar to youtube/medium in many aspects
- posts will be written in markdown
- related posts will also show up
- you can tag posts
- posts can be made private or link-only
- essentially just a privacy respecting, simple blogging network, where people can tell stories, write an article, etc
- i intend to make this somewhat social, eg. you can share your profile link with friends, follow people, etc

Thanks to @bittersweet I found and tried _Notes by Firefox_. An awesome app, wich I definitely will keep and use.

I love the markdown support.
I love the synchronisation.
I hope they will add access-controls, so I can give other users access to my notes.

Sry, for the advertisement.

Programmer? *triggered*

(Can we get markdown out there everyone? :wink:)

In an IT management class, the professor wanted us to estimate the operation costs for a small IT company, breaking them down by service offered. I remember creating a markdown file, multiple times executing the line `echo $RANDOM >> estimations.md`. We rounded the numbers slightly, pimped the document a bit and submitted a nice PDF. When we had to present our work, the professor asked us how we had proceeded to calculate those results. We told him a story about an Excel file we worked on, but did not submit, because we thought he'd be interested in the end result and not care about those details. He asked us to submit that Excel calculation, because he wanted to comprehend our method. So we got together, created an Excel sheet, copied our "estimations" into column C and called it "service cost". For column B, we used the same "cost per man hour" value (scientifically estimated using the RAND() function) for every row. Finally, we divided the "service cost" by the "cost per man hour" for every row, put the result in column A and called it "effort (in man hours)". The professor, being able to "reproduce" our estimation, accepted our solution.

Recruiters or their bosses with sick ambitions and zero feedback.

Do I need to say more?

Spent few days to make my site looking good on desktop/mobile with few screenshots and even video to show my working projects in production. Even more few days to make really detailed 2 A4 CV with my previous job and what I was doing there. All generated from markdown.

I even saved money around half a year to go and live month in other country (Ireland, Dublin) and then on site send about 150 applications on various sites, emails, linkedout and local IT meetings.

Null, nada, nil, NaN accepted applications.

Is it some kind of joke? All companies almost cries for new workers and they don't even answer someone which founded and have no problem with growing own IT company for almost 5 years with self learnt, practically applied in production linux, HTML, CSS, JS, PHP, Go, bash, KVM and Openvz virtualization knowledge?

What they really want?
Astronaut with Brainfuck and Cobol with fluent backwards speaking Esperanto riding on monocycle with 3 hands and no need for sleep for -1 whoopercoin?

I know many teachers are very emotional about technology as I've heard here.

My English teacher got next to me to ask what text editor I was using for writing a movie review. I was using VSCode and writing Markdown. He was like cool, smart. Didn't get it, but agreed.
I didn't expect that.

Folks,

What static site generator do you prefer, and why?

I want to set up a website for a small business and do not want to spend a lot of time on it but it also should be blazing fast.

My familiarity with react leads me to Gatsby, but there are probably good alternatives.

It should also be easy for the (non-tech) admin then to create posts on a news page or even new pages (probably with Markdown).

Thank you in advance!

!rant
Improvements for devRant

Add markdown support.
Change ++ -- button's color. (they look like they are disabled)

More probably coming soon

@dfox @trogus

Right now business is kind of slow for my company, so I've been working on Documentation. It's been kind of cool to make the gitlab repo, write the Markdown documents, and then push them to the repo when finished, but it's also hard because it's only me really doing anything...

Hey fellow devs,

This is my first rant.

Why are newlines ignored in the DevRant profile?!

And why no Markdown support?

Am I missing something?

When you write a manual in markdown about "HOW-TO use this program"....

Kill me

FUCK YOU EMOJIS! FUCK YOU AND YOUR EVER FUCKING GOD DAMN SPECIAL WAY OF BEING HANDLED.

Now that I have that part out...

I really fucking hate emoji at this time. Currently I'm working on one of my projects that has markdown support. One of the things I'm extendending the parser with is github style emoji (eg. :smile:) now this part works great. The problem however is getting that short code into a unicode char for HTML. And at the same time I have to take any unicode emoji inserted into the text box by phones and stuff and convert them into the shortcode (My database does support emoji but it's much nicer to store all emoji with the same standard)

All of this has taken 5 hours of research (needed a database of unicode -> short names) and several hours of converting the data from someone elses json into something I can use. (AKA Shrinking the damn file to only what I need) and now I've spent 5 more hours working on the actual code. And I still don't have it working properly.

Current status: Writing a markdown document containing all my tips and tricks for fixing bugs in our apps so we can handover to maintenance. Including files I commonly have to look in, handy keyboard shortcuts, IDE settings and other tools that have made debugging easier. I figure if these guys are having a bunch of legacy apps dumped on them when they have no iOS experience, I should help them out as much as I can before I move projects.

Note-taking app?

- viewed in browser
- server side self-hosted
- markdown for writing
- rendered pretty when viewing/next to markdown when editing
- folders/notebooks for sorting

during a programming introduction course on loops my pals started writing `for` loops instead of `while` loops like so:

`for (;expression;) {}`

spent weeks explaining why it's wrong. needless to say, they still do it. had to hinder myself from ripping my hair off my head

Had a markdown text in gitlab and tried to print it. It did not work.
Pasted it into atom then ctrl shift m
for markdown view and find out atom can not print. tried firefox instead of chrome, also no luck. After 15 min Odyssee I mark the text im chrome and rightclick+print it, works

- Holy
- Crap
- Zendesk
- Markdown
- List
- Sucks

This is why we can never have enough software developers

It's true. No matter how many people learn to program, there will never be enough people who know how to program. They don't have to be very good at it either. It is now a required skill.

Minimum wage in first world countries is way above 5$ per hour. A Raspberry PI 3B costs 40$, or at most 1 day of work for the worst paid jobs. And it will run for years, and do routine tasks up to thousands of times faster than any employee. With that, the only excuse that people still do routine tasks, is the inaccessibility of coder time.

Solution: everybody should know how to write code, even at the simplest level.

Blue-collar jobs: they will be obsolete. Many of them already are. The rest are waiting for their turn.

Marketing people - marketing is online. They need to know how to set up proper tracking in JS, how to get atomic data in some form of SQL, how to script some automated adjustments via APIs for ad budgets, etc. Right now they're asking for developers to do that. If they learn to do that, they'll be an independent, valued asset. Employers WILL ask for this as a bonus.
Project Managers - to manage developers, they need to know what they do. They need to know code, they have to know their way around repositories.
QA staff - scripted tests are the best, most efficient tests.
Finance - dropping Excel in favor of R with Markdown, Jupyter Notebooks or whatever, is much more efficient. Customizing / integrating their ERP with external systems is also something they could do if they knew how to code.

Operations / Category Management - most of it would go obsolete with more companies adopting APIs as a way to exchange important information, rather than phone calls and e-mails.

Who would not be replaced or who wouldn't benefit from programming? Innovative artists.

A lot of it might not be now now, but the current generation will see it already in their career.

If we educate people today, without advanced computer skills and some coding, then we are educating future deadbeats.

With all this, all education should include CS. And not just as a mandatory field or something. Make it more accessible, more interesting, more superficial if needed. Go straight to use cases, show its effectiveness in the easiest way possible. Inquisitive minds will fill in the blanks, and everyone else will at least know how to automate a part of their work.

devRant should support markdown... just saying.

Is there any extension for visual studio code that allows markdown to be exported as proper linked TOC PDF? I have tried now atleast 5 different combinations, pandoc, convert markdown etc. and they all produce either really non matching content (pandoc) or don't link the table of contents right. (but atleast show the content 1:1 of what the preview is..)

# HELLO NEWBIE HERE
```
planning to
support
markdown??
```

why are there so many markdown editors built in electron? is that like electron's hello world?

Using a markdown to styled html converter. FML

Am I the only one who thinks that it is put of hand this thing of "building" websites?

CoffeeScript -> JavaScript (+ 1M libraries)
SASS -> CSS (+ framework)
Markdown -> HTML

etc.

Does not his mean that we have failed at creating languages and tools?

Wow, I feel like idiot.

I struggled making documentation becouse I didn't know proper tools.

I sometimes used markdown but it was for internal git pages when I did, other times I just was doing crap within html (and I hate frontend and Dubba cannot frontend and its generally bad idea to give me html)

Than I had random talk with someone on the internet and he was suprised I never used (and known) markdown to html and I was more like "thats genius, why the fuck I didnt know its a thing".

goddamint...

Half a year or so ago I threw together a quick site for an old teacher of mine. Got a bit of cash for it and all was good. Now he needs a few changes, plus a whole new interactive page. Oh well... I restructured the whole thing and wrote a bare bones templating system in PHP. It can parse markdown files, so now he can fix his own fucking spelling errors. So now the shitty piece of crap is maintainable. Thanks fucking God for that.

I must assume that whoever designed jinja2 was either on crack, or hadn’t used template systems before. This thing is too fucking complicated, and doesn’t make sense. From their docs:

“Jinja2 supports dynamic inheritance and does not distinguish between parent and child template as long as no extends tag is visited. While this leads to the surprising behavior that everything before the first extends tag including whitespace is printed out instead of being ignored, it can be used for a neat trick.”

My response: “I don’t give a fuck!! I need this fucking website to be fucking done already! I pass data into a fucking template engine, and the engine applies my fucking markdown!! This is bullshit!! Why am I still trying to understand your fucking nonsense?!? AGGJCDJVFD&@!?&@$?)@&!SHHHVBSHK!!!!!!”
*desk flip*

Fuck you to hell you jinja fucker

So we're using Jira Wiki for all the documentation related work. It's hell rich with features as they describe. But for me easiest way is to write doc on markdown and then copy paste on Wiki. Highlights code, format tables and aligns paras perfectly.

Please add a `git log --grep=<pattern>` functionality to *devrant* ! Please. (Thanks in advance!)

Confluence. Somehow they decided it was a good idea to remove the markup editor, and now your can only use the WYSIWYG editor. WYSIWYG editors suck. So I have to memorize a crap ton of keyboard shortcuts instead of just writing confluence markup which was apparently very similar to markdown. Argh

Is there a tool that can auto-generate documentation (preferably in markdown) from javadoc?

Let me pretend this site supports markdown for this therapy session. Ever had a project with an `index.js` in every directory that looks like this?

```
import a from './a'
import b from './b'
...
import z from './z'

export default { a, b, ..., z }
```

If you do this, please stop.

1. `export default` for an object is not the same as having a named export for each of the property names in that object. In this form, someone has to first `import` the module's default export and then destructure it. This screws up tree-shaking and someone expecting a CommonJS module is bound to try destructuring it up front using a `const {} = require()`, which will blow up too unless you've configured a builder to "promote" default exports for ES6 modules. The way this is set up pleases literally no one.
2. I have to edit a file like this every time I add a new module to a directory. If you desperately want an experience where you can `import` against a directory and use named exports for files, you can configure a builder to generate those files for you. Stop making other people deal with this shit just because you don't like having more `import` statements at the top of your modules.

Bonus for you guys: I saw a team justify reducing the number of `import` lines with these index files because they also have a Java-inspired habit of exporting exactly one `default` symbol and nothing else from each module. Which means there are 30+ modules that each contain exactly one function. Half of the work days was file-hopping, and they didn't like the idea of combining modules with related functionality.

*think MarkDown* =>
.
## digital bohemian
I am a different kind of person
I think in color, and breathe in static
My people are **electric**
.
We come from the planet
... after Pluto, and love machines beautiful
We have _souls_ prone to changes
When we push and pull our hearts
.
We are of the race, digital && bohemian
I am a coder, my lovers are alien
.
CTRL+C : that is all

What kind of software you guys use for internal documentation? Currently we use Dropbox paper but I'm having doubts about it and I'd like to hear some suggestions.
It must support markdown (syntax highlighting would be nice) and I'd like it to be cloud hosted and free or at least cheap :)

I'm not explicitly looking for an alternative but should an awesome suggestion appear I'd switch over.

Why can't more stuff support markdown?

I have had more reasons to use it lately, outside of repo READMEs, and (re)discovered just how awesome it can be in different text situations.

One year ago I made a resolution to do one of two things: get serious about learning neural networks, or finish one of the side projects (markdown based wiki with some nifty features). Didn't do the first one, and got the second one to about 50%.

Not really happy as I did not complete any goal. Still some decent work was done and built an open source parser. So, I guess I am 50% happy.

What were your achievements this year? Did you achieve 100%?

It appears Facebook Messenger has started supporting a very limited markdown...

You can now use stuff like *bold* and _italic_ it seems...

Is there any alternatives to Atlassian's Confluence and Jira?

We used to use GitHub projects and wiki, but "the business" wanted a more formalised process and access controls on kanban boards and backlogs.

We started using Jira and Confluence last month, but Jira have been incredibly slow with a horrible interface also Everytime I create a new issue it feels like I'm wasting a lot of time compared to the time needed to setup an issue on GH and add it to a project board, plus the entire team is used to using markdown which doesn't work great on Jira.

I've looked for some alternative but I wonder what you are using out there!

Providing a nice Readme.md file with your open source project is never enough. You need to have a beautifully designed website for the documentation to go with it, oh yes sir!

!rant

I just added a custom zsh function to read .md files in iTerm. Life is going to be a lot easier now!

markdown4documentation is a tool that can either convert a single markdown file, a complete directory or a complex structure to HTML or PDF. You can choose between several build-in themes (called templates) or define a custom theme.

Moved from Wordpress to Hugo + Github pages. Blogging is now so much better. Markdown support on the free version of Wordpress sucks.

College writes a API documentation. Refuses do use markdown or simple HTML. We need to use a custom php class.

Each paragraph is a protected function with an array of multiple languages (never gets translated anyway...)

Drupal developers...

I'm a frontend developer maybe i'm missing the point, can someone enlighten me please.

Recently I've been tasked with setting up of a small /mid-size infrastructure and I've been documenting things like infrastructure design, network configuration all the way to playbooks and cluster configuration.
Since I just started with this, until now I have been doing this in a Google doc / some spread around markdown files. I would like to have a better way of having this documentation hosted internally..
I have been playing around with local installations of rtd, gitbook and mkdocs. So far, I've liked the simplicity and customizability of mkdocs.

Any other options before I commit myself to mkdocs?

Considering that Markdown exists and Readme files are rendered by default in GitLab, Github, and so on

Why devs insist on documenting stuff on Confluence?

About JS WYSIWYG editors.

When you're working on a project that does require a such editor, which solution do you usually chose and why ?

- existing library (which one ?)
- coding your own
- no fancy editor, just markdown
- no fancy editor, just bbcode or equivalent

First semester tutorials are fun (spoiler they can be frustrating).

Today my University held an entry level tutorial for LaTeX, which I had already visited a year ago and offered to help and boy ohh boy was that painful. For your information all of these students want to study computer science.

From around 50 people there was only one person who used Linux and I thought "Well at least one".

I was even more impressed as the other tutors asked me to help her because she used Manjaro (also the distribution I use).

As i helped her installing texstudio (the software presented) I needed her to enter the root (?) password and she answered "Which password, it's the laptop of my sister, I thought the laptop had windows installed".

Everything worked out fine but this was only the beginning.

After an hour came the first exercise in which the students had to build a simple document and for everyone who doesn't know LaTeX, it's a markdown language which heavily relies on \ and {}.

And there laid the other most common problem, some Mac users didn't even know how to write a \ or {}.

At least I had some fun helping them but if you want to study computer science you should be able to know how to write some of the most common symbols in programming languages.

@dfox how about markdown support for rants and comments? It'd be great to express some stuff better!

Currently building a random psychology website. Why? Psych major, final year. Will I be using lesscss? { nah } ... fancy js? { nah }

It will be a simple fucking doc style website. With markdown files and minimal styling. I need to become a better backend dev either way.

My side project has been a SPA. One part was to make it "serverless" (folder of markdown and html files for content,config.json, no database). Another part was I wanted anybody to be able to choose whatever theme/framework they wanted and easily be able to change the config file, so I looked for a templating framework... and found PugJs. I choose it solely because I liked the logo :^).

3 days later, after successfully figuring out how to use pugjs on the client side, implementing different templates, and making sure everything loaded in the right order. I tested how big the website was without any content.

Woof.

So I'm just going to use a feature that was already in Bone.io to begin with :^). (Bone.io has a router and a "view mount" feature)

What's your favourite mobile code editor? I currently have DroidEdit, but was curious what others use?

Does anyone code on their mobile to begin with? I write a lot of markdown text files and push to Github via mobile and could use a solid text editor.

Confluence WYSIWYG-editor shall burn in a thousand hells. This thing pretends to be smart, yet all its autoformatting achieves is to enrage me. I don't remember dropping so many f-bombs in such a short time frame.

I hoped to ease to the pain by writing markdown, yet I can only write markdown in a new insert markup window which does not even comprehend nested lists. And don't get me started that it wants to push its Confluence Wiki syntax first. Why does it need to reinvent the wheel?

Why can't I disable the WYSIWYG feel of it and just write plain old markdown?

Confluence, you are part of the problem!

I rather keep the documetnation inside the git repostory inside of md files. But no, confluence shall be our source of soon to be outdated documentation.

Sigh.

I hate doc comments in Rust. They are literally just markdown without any special syntax for documenting stuff. What the actual fuck. Why can't everbody just straight up copy how javadoc does it 😭

README.md, is there any way in bitbucket/stash to customize the index markdown to be rendered other than README.md?

Anybody know a way to very quickly insert images/doodles when editing markdown?

For example, In a calc class, I want to be able to type text, then hit a keybind and have a pane where I can doodle a math equation instead of using latex or some other lookalike, then hit enter and insert in and continue on my merry way.

OneNote is not an option and I'm running on a type of Ubuntu 😁

Please give us Markdown in Slack already. How can that be much more "difficult" compared to Slack's own formatting?

At least give me the possibility to temporarily disable formatting, e.g. to not make bold when using asterisks. No, using inline code formatting is not a viable option. I simply want to have asterisks shown as normal text. I'm fine with escaping with e.g. backslashes. That's kinda normal.

BeautifulSoup (python module) doc is a single block of text which has an everlasting scrolling and hard to read. Examples are ok, but come on, we're devs, not text parsers. We need clear, clean and visual documentation. I neither like the organization of the Facebook API docs. It was a nightmare to build my first simple app. There are tons of this kind of messy, almost unreadable and confusing docs. It's strange, but usually these kind of docs are related to open source projects. Long life to markdown and github.

@dfox this app totally needs code formatting :D maybe in markdown style?
```
// code
```

I have been keeping track of Todo's using markdown files and git. Love it. Any one else do it or ideas ?

I've been using Bear which is a markdown editor with iOS and mac support. While markdown is good, I've found myself needing to use LateX for equations in my notes (doing math / theory stuff). I switched to a VS Code extension which is markdown + MathJAX. How do you guys take notes?

Fellow devs, I'm looking for a CMS which has markdown support and allows authorized entry.
Basically we are working with some clients on some IP. We want to convey what we have worked up via a website. But we want the access to be regulated.
We are currently using wiki to maintain the information.
What are my alternatives?

Any one has recommendations of online mark down tool? Such a pain in the ass to create dev doc in google doc, especially when you trying to add the number index in the front.

looking for suggestions for a self hosted CMS. I tried Ghost, and it looks real nice, but there's no option to have just 1 section be private, you can only make the whole thing private. I tried Drupal but honestly it's just way too complicated for what I need, and doesn't look very aesthetically pleasing.
basically, here's the features I'm looking for:
- ability to set privacy/access control on a per-page or per-section basis
- Markdown for content editing
- ability to use regular HTML when needed
- ability to upload content via an API (so that I can publish documentation via my gitlab CI)

!rant
@dfox why don't you incorporate markdown library in devRant.. That'd be so much fun!

It's 2016 and I still could not find a simple Markdown to HTML generator that mirrors the directory structure and does not require me to spend 20 million years with configs.

Had to roll my own.

RestructuredText or Markdown or MultiMarkdown.

!rant
So, I wanted a little suggestion here.
I'm currently interning at a startup and currently we document our build procedures by creating .docx files containing the steps. But docx is a pain in the ass. I'd rather prefer markdown for documentation.
Are there any better tools for documenting? What do you guys use?

We're using Jira for project management bdw.

That moment when you writes every document in markdown and put them in a git repository for version control.

Can anyone recommend a good JavaScript/jquery markdown editor that supports file uploads for images?

Working on a new laravel project and want to use markdown instead of WYSIWYG.