Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
-
@pentatonicfunk any recommendations?
-
@BadFox been using stackedit, but typora seems promising. anyway GIYF
-
I suggest using https://github.com/canonical-websit...
This creates a structured documentation and tutorial series. Easy to deploy and write the documentation as it uses markdown . -
@arunkumar413 thanks.
-
@arunkumar413 thanks man, I was looking for something like that for ages
-
Well, i guess everything that is not compiled is just a text file?
Word is awfull to document these shit, I agree. But markup it not the best thing either.
What language are you on? Isn't there something to generate your docs based on comments?
You comment good, you get your docs, it's a double win. -
https://typora.io for writing and vuepress https://vuepress.vuejs.org for good looking documentation.
and remeber to use screencapture webm videos to explain things.
edit: use www.pandoc.org to convert those word or any text based file formats into markdown.
when your code is a mess but everything work out in the end
When you keep getting +1s on a rant you posted a month ago.
Go big or go home.
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.
rant