FYI - Markdown is simply a specific implementation of the category of languages we call Markup. For sure markup languages are the future way of documenting especially technical engineering projects, small and large.
This is one of the best tech videos I've seen. Good balance of telling me about a couple things I hadn't seen before, and showing how to use. The completeness of your references and toc in the description was so useful.
Great info,thanks, Many organisations still use microsoft word as primary documentation software, (ultimately it is duplicated in fancy Adobe suite but mostly it starts with ms word) which is probably worst choice. Text based document is way to go forward.
omg, this is so good. I have been looking for something to draw a timing diagram for years. Do you have anything to draw geometric diagrams especially representing angles?
This is a great video. Also it is not surprising that Hardware folks are never aware of JS frameworks. I have worked both on web application and embedded application. Never thought of making use of these js libraries for use. Thanks!!
Yes, you have identified the skill or awareness gap between the hardware and web developers correctly :) As I learn how to use these skills from both areas in IoT technologies, I hope to share them in such videos as well.
It's actually the August 2018 edition of Increment increment.com/about, a print and digital magazine by Stripe stripe.com: increment.com/documentation/
2:20 Cool tool, but the generator on github pages doesn't support it. Fortunately, you can include a third-party template. You do not need to copy the template to your repository. 👍
Yeah, all the Markdown-based documentation won't be supported when you view them on GitHub or any other Markdown reader. I prefer to simply render them as a webpage / HTML and send the URL to the readers. Either way, as you mentioned there are many other options 🙏🏼 Could you give an example of a third-party template? I didn't understand that part about copying the template to my repository 😅
@@sayanee Yes please. Here is an example of loading a third-party template, while graphs are drawn directly on the site. github.com/kc-doam/manual/ As it turned out, in the settings not needed. *plugins:* *- jekyll-remote-theme*
FYI - Markdown is simply a specific implementation of the category of languages we call Markup. For sure markup languages are the future way of documenting especially technical engineering projects, small and large.
This is one of the best tech videos I've seen. Good balance of telling me about a couple things I hadn't seen before, and showing how to use. The completeness of your references and toc in the description was so useful.
Thanks for this video. I’m mechanical Engineer and this give me a lot of ideas 💡 how i can make nice documentations
It feels like you unloaded your brain into a video. Very interesting and amazingly useful tips, thank you for sharing your knowledge.
Great info,thanks, Many organisations still use microsoft word as primary documentation software, (ultimately it is duplicated in fancy Adobe suite but mostly it starts with ms word) which is probably worst choice. Text based document is way to go forward.
👍🏼 learnt a lot in such a short time… #writethedocs
Thank you for another great video, Sayanee.
I didn't know about Wavedrom, it's amazing :D
Excellent video
Just awesome
Beautiful and well explained demos
Will use in my Network security blogs and diagrams
omg, this is so good. I have been looking for something to draw a timing diagram for years. Do you have anything to draw geometric diagrams especially representing angles?
If it's anything more complicated like geometric diagrams, I'm guessing you will have to use hand-code SVG. Maybe try d3js d3js.org/
thanks you for the info. I have been slopy with my documentations over the years. I will get back on track with your advice.
This is a great video. Also it is not surprising that Hardware folks are never aware of JS frameworks. I have worked both on web application and embedded application. Never thought of making use of these js libraries for use. Thanks!!
Yes, you have identified the skill or awareness gap between the hardware and web developers correctly :)
As I learn how to use these skills from both areas in IoT technologies, I hope to share them in such videos as well.
@@sayanee Looking forward. I am also watching the videos that I have missed from the channel.
Nicely presented. Lucid and to the point. Thanks for sharing.
Amazing tools to create technical docs! Thanks a lot for sharing, new subscriber :D
Wow, very helpful.... Great video thank you :)
Absolutely wonderful !! Thank you so much Sayanee for this extremely useful & informative walkthrough of markdown.
This is very helpful. Thank you for the details.
I was in need of something like this without even knowing it :D Very helpful tutorial
Thank you for this! I recently started a new technical writing job with a team that needs their code documented and these are great tips.
Thanks a ton for sharing these tools. It’s been a struggle to draw flow charts with drag and drop tools.
awesome, wish I had saw your clip year ago, so productive!
Your videos are always very useful. Great content !
This is awesome, I'm now subscribed!
Great video 💚 It has given me so many ideas to implement in my ongoing projects
Thanks Madam.
From south India.
Great info. Thank you!
OMG interactive html bom is soo cool
Beautifully explained!!⭐❤
Great methodology 👍💖
Very good. Thanks.
Hey, thank you for the great video, can you please tell us the name of the book and author Documentation on your desk please.
Thanks!
It's actually the August 2018 edition of Increment increment.com/about, a print and digital magazine by Stripe stripe.com: increment.com/documentation/
This is great thank you!
What is the colour scheme that you're using in iTerm2?
Oh no! I keep changing it 😅 I believe this one was either Atom or Material dark theme. Even within Atom / Material, they have variants.
Great video, thanks 👍
Thank you so much
2:20 Cool tool, but the generator on github pages doesn't support it. Fortunately, you can include a third-party template. You do not need to copy the template to your repository. 👍
Yeah, all the Markdown-based documentation won't be supported when you view them on GitHub or any other Markdown reader. I prefer to simply render them as a webpage / HTML and send the URL to the readers. Either way, as you mentioned there are many other options 🙏🏼
Could you give an example of a third-party template? I didn't understand that part about copying the template to my repository 😅
@@sayanee Yes please. Here is an example of loading a third-party template, while graphs are drawn directly on the site.
github.com/kc-doam/manual/
As it turned out, in the settings not needed.
*plugins:*
*- jekyll-remote-theme*
Thank you
Good work 👍❤
Bengali?
Yes, I am :)
dekhei bujhechi..amio didi.. nice to meet you..
@@sandhyaash7134 Amaro khub bhalo laglo!