Improving Documentation to Encourage Community Contributions

[petertzy]

Everyone is welcome

A well-crafted and visually appealing documentation can attract more people to participate in a project and contribute code. We hope that anyone interested will join us in improving this project’s documentation, especially the README.md file.

Added new features:

• Double-clicking a .md file opens it with the app generated by this project and displays the document.
• Change the behavior so that double-clicking a .md file opens only the editor page, without automatically generating and opening a web preview.
• Support rendering of complex mathematical formulas.
• Add the ability to create and edit tables.
• Add animated demonstrations.
• Build a polished app with full support for Apple platforms.
• Enable conversion of .md files to Word documents.
• Enable conversion of .md files to HTML files.
• Open an HTML file and display its content in Markdown format within the Markdown editor.

Anyone with interest or ideas is very welcome to contribute.

[lwu1822]

This project is cool. I'd like to play around with the project and contribute to the documentation!

[petertzy]

This project is cool. I'd like to play around with the project and contribute to the documentation!

You are welcome.

[CarlosHCS001]

Hey! I just found this issue and I think I can help with the README documentation. I'll start working on documenting the new features listed. is it okay?

[lwu1822]

I can help as well! I also have an idea, I think it would be good to have a website that hosts the documentation. Curious to hear your thoughts? 😃

[petertzy]

Hey! I just found this issue and I think I can help with the README documentation. I'll start working on documenting the new features listed. is it okay?

Hi @CarlosHCS001 ,
thanks a lot for your help with improving the README documentation.
I’ve reviewed your changes — they really improve the readability and provide more precise details, which is very helpful.
I’ve merged your branch. Excellent work, thank you!

[petertzy]

I can help as well! I also have an idea, I think it would be good to have a website that hosts the documentation. Curious to hear your thoughts? 😃

Hi @lwu1822,
thanks for the idea — a dedicated documentation website sounds like a really great addition.
I also had a look at some of your previous work, and you clearly have a good eye for design, so I think you’d be a great fit for this.
Feel free to approach it in whatever way you think works best. You can host it on your own GitHub Pages or on this project’s GitHub Pages — both options are totally fine for me.
Really appreciate you taking the initiative here, looking forward to seeing what you come up with.

[lwu1822]

Thanks! I really appreciate the kind words and the flexibility!