DEV Community

A tool for building intuitive code documentation

Moksh Jawa on January 23, 2020

Hi dev.to, We're Rishabh, Aashish, Noah, and Moksh, the creators of Codeflow: a tool for building intuitive documentation for code. You can check ...
Collapse
 
andrzejwp profile image
andrzejwp •

Hi guys, it's pretty interesting. Is there any documentation I can read to find out how this works?

Collapse
 
aashj profile image
Aashish Jain •

Hi,

We have an FAQ page that we're actively adding to. Codeflow has you authenticate via GitHub, and then displays your code in our editor. You can create tutorials from our editor to share with others. Let me know if you have any more questions!

Best,
Aashish

Collapse
 
theodesp profile image
Theofanis Despoudis •

Nice. I noticed though that the code comments are really faded on my MAC

img

Collapse
 
aashj profile image
Aashish Jain •

In Codeflow you can intentionally choose to highlight certain parts of the code. Looks like this tutorial just wanted to highlight those aspects. Do you think non-highlighted lines are too faded?

Collapse
 
theodesp profile image
Theofanis Despoudis •

It's very hard to read. May a different color scheme is preferred.

Collapse
 
fennecdjay profile image
Jérémie Astor • • Edited

Maybe I missed something, but I have a few question.

Does it support any language?

Would it support some code execution ?

Collapse
 
aashj profile image
Aashish Jain •

Hi,

Codeflow supports any language, as it works via GitHub authentication. You can create tutorials from our editor to share around. Currently we don't support code execution in browser, but it's a feature that's on our radar!

Best,
Aashish

Collapse
 
fennecdjay profile image
Jérémie Astor •

Thanks for your answer.

Collapse
 
aashj profile image
Aashish Jain •

Hi, I'm Aashish one of the contributors. We'd love to answer any questions/feedback you guys have!

Collapse
 
oaksupreme_ profile image
Franje •

Wow!!This is amazing. Keep up

Collapse
 
aashj profile image
Aashish Jain •

Thanks so much for your support!

Best,
Aashish Jain