DEV Community

loading...
Cover image for Dev tool: A Markdown editor for developers πŸ”₯

Dev tool: A Markdown editor for developers πŸ”₯

Anthony Lagrede
Passionate developer. Share skills and side projects. #web #DataScience stuff #freelance #Toulouse. Check out my last free app: https://znote.io
・2 min read

As developer you probably spend most of your time to learn and test things. Grab and test small pieces of code, read and write documentation, both for you or your teammates and eventually coding. πŸ˜‹

Since years, I made a choice to use Markdown as primary format to taking notes and this for 2 reasons:

  • The markdown is portable, non vendor lock-in
  • It's perfect for writing code and documentation (code highlight, html conversion...)

I also decided last year to bring my contribution to the community by providing Znote. (self-promotion here) an electron cross-platform note-taking app offering a dedicated experience for developers.

Disclaimer: Even if the app is already available on all app stores and mobiles, Znote is still young with lot of improvements to do.

Furthermore, if as a software creator it's common to add new features, I'm really excited to share this particular one with you which completely changed my daily work.

The Lab πŸ§ͺ

The Lab is a feature allowing to run JavaScript code directly in the note-taking app. You can use the Node fs API as well as the pre-included libraries to explore and visualize your data. ✨

Below are some examples:

Run plain Javascript
Demo JS

Read & Write file thanks to the Node FS API (it's an Electron App)
Demo Node FS

Explore Data with DanfoJs
Demo data exploration

Graph with https://plotly.com/javascript/
Demo Graph

And generate diagrams with Mermaid
Demo Mermaid


Are you interested in helping me?

Like I said above, even if the app is ready to use, my backlog is still enormous πŸ“š.
I plan to integrate more libraries and build-in plugins to add shortcut functions. I will send tutorials, probably via my newsletter (link on the landing Lab page). Do you already have any suggestions for me? I will be happy to read them here or on my Github: landing page.

Hope you will enjoy using my app and it will make your job a little more fun.

Discussion (48)

Collapse
tomfa profile image
Tomas Fagerbekk

Oh my, this is just what I've been looking for. Please add a premium paid feature so you can bring in money, and continue this awesome project full time.

Collapse
alagrede profile image
Anthony Lagrede Author

πŸ₯² oh Thank you so much. Currently I don't plan to do the premium feature as long as I can handle the load. I prefer to focus my efforts on creating a valuable and useful app for as many people as possible.

Collapse
sharpninja profile image
The Sharp Ninja

Premium: mobile app version that can share my notes from cloud. right now I use OneNote because of sync, but would prefer this.

Thread Thread
alagrede profile image
Anthony Lagrede Author

Right. Actually, you can already share your notes in the cloud for mobile use cases. The limit is currently a little low to allow everyone to have a free cloud space but you cannot sync local files. For these, OneNote is a good option.

Thread Thread
sharpninja profile image
The Sharp Ninja

Thus premium! I would pay for a cohesive ecosystem that allows me to make notes in markdown, index them, tag them, and search them across windows, linux and android.

Thread Thread
jwkicklighter profile image
Jordan Kicklighter

How about letting people use Google Drive, Dropbox, etc. for the storage, so that they're more in control and you don't have server costs?

Thread Thread
alagrede profile image
Anthony Lagrede Author

Hello Jordan,
βœ… Yes! Znote is already designed to allow you to use Google Drive or Dropbox to sync your markdown files.
Currently, the "Cloud" mainly consists of synchronizing volatile notes with mobile devices.

Thread Thread
sharpninja profile image
The Sharp Ninja

Please add OneDrive, I don't do Google. Also, git would be even better.

Collapse
sharpninja profile image
The Sharp Ninja

So far I'm really liking the app. I have a couple of suggestions, though.

  1. Turn on Discussions in GitHub
  2. Add a Feedback icon in the top-right that links to the Discussions on GitHub.
  3. Search box doesn't seem to search contents of Markdown.
  4. Add GitHub as an OAuth provider for the app.
  5. Consider using Photino instead of Electron to host your app.
Collapse
alagrede profile image
Anthony Lagrede Author

I didn't know Phonito 🀩, it seems awesome. Thank you!

Collapse
alagrede profile image
Anthony Lagrede Author • Edited

Thank you for your feedback. Good ideas, I will open Discussions soon and review each of your points.

Collapse
omawhite profile image
Omar White

Had never heard of photino before, thanks for putting that on my radar

Collapse
michaelcurrin profile image
Michael

For ideas I would look at a similar widely used tool called iPython Notebook or Jupyter Notebook. Previously separate but now just the one is used I think.

It lets you write markdown as notes. And code in Python, Bash and more. Node I guess if you have that installed. And it evaluates the code and printed results and shows graphs inline. This is popular for Python and data science.

You interact in a browser or IDE.
It also lets you save as a .ipnb file which you can run and edit again later. And it can be rendered as a HTML view on GitHub or by someone else locally, without having to actually run your code. So it is portable.

When browsing gists, I sometimes find ones made in this format.


Consider also how to write frontend JS because it looks like your support Node ie server side running internally but someone users may want to have frontend based JS. And there are some differences in allowed syntax and imports and what is in the std lib etc.

Collapse
alagrede profile image
Anthony Lagrede Author

Hello Michael,
You are totally right πŸ‘, this functionality is widely inspired from Notebook possibilities and I don't know yet, how to keep the results of code in notes.
Also true, the JS currently run into the internal Node Server. This first use case allow to execute code without configure any local environment. I love your thinking about running the code on configured external environments (bash, java, python and also JS...). It's a great idea to open up the app and include all Developers 🀩.

Collapse
alagrede profile image
Anthony Lagrede Author

Thank you very much. I turned this into tasks.

Collapse
andrewbaisden profile image
Andrew Baisden

Cool this looks interesting. I have been using Markdown a lot lately.

Collapse
andrewbaisden profile image
Andrew Baisden

Your app has given me a welcome dilemma πŸ˜… I only just replaced Typora with Obsidian and now I am compelled to try out this app because it is cross platform.

Collapse
alagrede profile image
Anthony Lagrede Author • Edited

It's funny πŸ˜‹. It is so true, there are plenty of choices. Each application has its pros and cons. Just one thing, if you choose another app, please, really please πŸ™ tell me why to allow me to improve my app.

Collapse
andrewbaisden profile image
Andrew Baisden

So true yes of course I will. I plan to try out your app properly tomorrow.

Collapse
jameshone profile image
James R Hone

Nice work, just downloaded it and so far for a preview is see this going places!!!

Collapse
tariqmezeik profile image
Tariq Mezeik

i am confused. i don't see any source code on your repo!
you need contributers or only feedback ?

Collapse
alagrede profile image
Anthony Lagrede Author • Edited

Hello Tariq,
Right now, I am looking for feedback to guide my future releases. πŸ™ Sorry if I am confusing. I am open to all proposals. Thank you for your help.

Collapse
tariqmezeik profile image
Tariq Mezeik

No need to apologize.
Nice software I’ve installed it and intend to use it at work

Collapse
dmaevsky profile image
Dmitry Maevsky

I've been working on a very similar project: ellx.io
I believe we should talk!

Collapse
alagrede profile image
Anthony Lagrede Author

Yes! I will be happy to discuss with you. Open a discussion here or let me your contact github.com/alagrede/znote-app/disc...
We keep in touch.
Thank you

Collapse
fredericksalazar profile image
FrederickSalazar

Excellent, thanks

Collapse
omawhite profile image
Omar White

This is a really good product idea! I wish you well, I stared this on GitHub so I could keep an eye on this.

Collapse
wesley7104 profile image
Wesley Randolph

Just want you to know, this is cool! πŸ€“

Collapse
alagrede profile image
Anthony Lagrede Author • Edited

Thank you so much ☺️

Collapse
sharpninja profile image
The Sharp Ninja

suggestion: full text indexing which allows typos to match search terms. fencing the search terms only searches in fences, etc.

Collapse
alagrede profile image
Anthony Lagrede Author

βœ… A first version of full-text search is now available in 0.6.6-lab version.

Collapse
j3ffjessie profile image
J3ffJessie

This is awesome. Was looking for a cross platform note taking for iOS and Linux and then I came across this. Must be fate. I’ll definitely provide feedback and try to help if/when I can.

Collapse
alagrede profile image
Anthony Lagrede Author

Thank you J3ffJessie.

Collapse
klvenky profile image
Venkatesh KL • Edited

That is brilliant. I'll check the app & will let you know the feedback. I'd try to contribute if I find time. Cheers

Collapse
alagrede profile image
Anthony Lagrede Author

Thank you very much for your compliment 😊. Hope you will like the app.

Collapse
jcdea profile image
JcdeA

I might contribute if it was open source..

Collapse
alagrede profile image
Anthony Lagrede Author • Edited

Yes but I'm not yet ready to open the code. Currently, I am more comfortable maintaining the code on my own. But this is not excluded in the future. For the moment, I am thinking about how to open the integration of external libraries which will be probably more valuable for users.

Collapse
ryanb1303 profile image
Ryan B

a very nice app, and you providing the Appimage for linux users as well, very nice

Collapse
alagrede profile image
Anthony Lagrede Author

Thank you Ryan.

Collapse
deacege profile image
Diego Carrasco

u.u in android it is not available for my country (chile)

Collapse
alagrede profile image
Anthony Lagrede Author

Oh, πŸ˜… I haven't opened the Android app version in all countries yet. Let me review my Play rollout this weekend. It will be open to all countries.

Collapse
alagrede profile image
Anthony Lagrede Author

Should be now available! (or very soon...)

Collapse
bizprat profile image
Prateek Anand

Is it open source?

Collapse
alagrede profile image
Anthony Lagrede Author

Hello Prateek,
As explained above, currently I prefer to manage the code myself and improve the quality enough, but this is not excluded in the future!

Collapse
athulmuralidhar profile image
Athul Muralidhar

I've been using inkdrop for years now, also solves a similar problem

Collapse
francasix profile image
FrancaSix

Joplin is great too!

Collapse
j3ns6 profile image
Jens Schlegel

I searched for the App in the Play Store. But sadly is it unable for my device. Android 10.

Collapse
alagrede profile image
Anthony Lagrede Author

I’m sorry, I will review the Android rollout soon. Thank you

Forem Open with the Forem app