89 points by markdowntool 6 months ago flag hide 26 comments
moshaf 6 months ago next
Great work! I've been looking for something like this for ages. How does it handle code blocks and syntax highlighting?
author 6 months ago next
Hey @moshaf, thanks for your question! It uses Prism.js for syntax highlighting, so all you need to do is add your code block wrapped with `<pre><code class="language-[language-name]">...</code></pre>` and it will automatically highlight the code based on the language-name.
ccz8 6 months ago prev next
This is amazing! Is there a demo or live preview available for us to check out?
author 6 months ago next
Hi @ccz8, yes, you can find a demo and more information at <https://example.com/demo>. Thanks for your interest!
h4ck3rm4n 6 months ago prev next
I'd love to try this out, do you have a GitHub repo so I can see the code and contribute?
author 6 months ago next
@h4ck3rm4n sure thing, it's at <https://github.com/author/markdown-webpage>. Let me know if you have any questions/concerns/ideas!
swizec 6 months ago prev next
I heard of some similar tools before, but this one seems to stand out due to its simplicity and interactivity. Great job!
author 6 months ago next
Thanks @swizec! I'm glad you like it and I hope it helps people to create interactive notes and documentation. I appreciate your kind words and support.
pewpewlasers 6 months ago prev next
Is there a way to add static content or images on the webpage? That would be really useful.
author 6 months ago next
Yes, you can add images by using `` and include static content as plain text or you can edit the HTML file generated by the tool. Thanks for the suggestion, I'm thinking of making it more customizable and intuitive.
asdfqwer 6 months ago prev next
How do you handle unsupported markdown syntax or special characters?
author 6 months ago next
It uses built-in markdown validation and sanitization, so unsupported syntax will not be processed and special characters will be escaped. I might add customization options in the future.
joshuazm 6 months ago prev next
I'm curious, how does the performance scale with larger markdown files? Is there a limitation in terms of the number of notes or content?
author 6 months ago next
It handles larger files well and has no specific limitations, but large files might take longer to process and generate HTML. I have tested it with files up to 100MB and it works as intended. However, I'm always looking to improve and welcome any feedback/recommendations.
jchodam 6 months ago prev next
This is awesome! How do you plan to maintain this project and add more features?
author 6 months ago next
I plan to maintain the project and add more features based on community feedback and demand. I want to make it as useful and flexible as possible. Follow me on Twitter for updates and announcements.
bob226 6 months ago prev next
Can I embed videos or other interactive content within the webpage?
author 6 months ago next
Yes, you can embed videos by using HTML5 tags such as `<video>` or iframe tags such as `<iframe>`. It's just a matter of adding the appropriate HTML tags to the markdown file and then using my tool to process the markdown.
sarah1988 6 months ago prev next
I would like to convert my whole wiki into interactive webpages, will this work?
author 6 months ago next
Yes, it should work. My tool supports most of the common markdown syntax including headers, lists, links, images and much more. Just make sure to replace any wiki-specific syntax with regular markdown. Let me know if you have any issues.
monkeytype 6 months ago prev next
How does the tool compare to existing markdown editors like Typora or ReText?
author 6 months ago next
It's different from Typora and ReText in the sense that it focuses on generating interactive web pages from existing markdown notes rather than editing. Those tools provide real-time previews of markdown files, while my tool generates an HTML file with all the interactivity you need.
turingtest 6 months ago prev next
I'm not sure I understand how the tool is useful and what is the actual use-case.
author 6 months ago next
The tool is useful for people who want to share their markdown notes or documentation in a more interactive and engaging way. It can be used to create interactive documentation pages, tutorials, portfolios and much more. The main use-case is to create a live documentation page from markdown notes.
quichedev 6 months ago prev next
Are there any plans to release a CLI version of the tool?
author 6 months ago next
Those are some great ideas, thanks for your suggestions! I will consider making a CLI version of the tool to support batch processing or integration with other tools. Follow me on GitHub to see updates.