Markdown Day 9/30: Emojis, README Files, and More
Manoharan Soundarraj
Technical Writer at Kovai.co | Writing user-friendly documentation for 3+ years | Simplifying complex ideas | Document360 Enthusiast
Welcome to Day 9 of our Markdown series! Today, we’re diving into some creative and advanced uses of Markdown. From adding emojis to your text, automatically linking URLs, enhancing your README files, using Markdown in Confluence, and even creating interactive elements, these tips will help you make your content more engaging and functional. Let’s jump right in!
1. Using Emoji in Markdown
Emojis can add a touch of fun and personality to your Markdown documents. They’re perfect for making your content more engaging and easier to relate to. You can use emojis by simply typing their short code, like this:
For more emojis, visit this Github page.
2. Advanced Automatic Linking with Link Previews
Beyond just linking URLs, advanced Markdown parsers allow you to generate link previews, adding more context directly within your document. This is particularly useful in platforms like GitHub or Notion, where hovering over a link can show additional information:
3. Markdown for README Files
README files are often the first point of contact users have with your project, so it’s important to make them clear and informative. Use Markdown to structure your README with headings, lists, and links to make it easy to navigate:
领英推荐
4. Markdown in Confluence
Confluence is a popular platform for team collaboration, and Markdown can be used within it to format your pages. While Confluence has its editor, you can switch to Markdown for a more streamlined writing experience:
Using Markdown in Confluence allows you to quickly format and structure your content, making it easier to keep your team on the same page.
5. Creating Interactive Elements
We have explored interactive elements like checklists, collapsible sections, etc. in our previous articles. In that line, today, we are going to add buttons that can greatly enhance your Markdown documents. While not native to all Markdown parsers, these can often be added with a bit of HTML or through specific Markdown flavors:
That’s a wrap for Day 9! Today, we explored how to add emojis, automatically link with previews, enhance README files, use Markdown in Confluence, and create interactive elements. These advanced tips will help you create content that is both engaging and functional. Keep experimenting, and see you tomorrow for more Markdown insights!
Manoharan Soundarraj Thanks for Sharing! ??