· 3 min read
Essential Markdown Guide for Web Developers
Master markdown formatting with this comprehensive guide. Perfect for developers working with documentation, READMEs, and content management.
New Zealand has three official languages: English, Te Reo Māori, and New Zealand Sign Language.
English is the primary language; however, around 4% (or 140,000) of people speak Te Reo. This makes it the second most commonly spoken language in New Zealand.
The Māori language(opens in new window) is considered a national tāonga (treasure) and is undergoing a significant revival. Initiatives such as Te Wiki o te reo Māori (Māori Language Week), Kura Kaupapa (Māori language schools from pre-school through to high school) and a Māori Television all playing a role in making sure Te Reo Māori remains a living language embraced throughout New Zealand.
You can help support Te Reo Māori by making an effort to get pronunciation right and using simple words and phrases in everyday conversation.
Greetings in Te Reo Māori Woman at Mount Hikurangi Tairāwhiti Gisborne Woman at Mount Hikurangi, Tairāwhiti Gisborne By Matt Crawford
Learning basic Māori greetings (mihi) is a great place to start. Try using these anywhere you go in New Zealand - quite often, the response will be a wide smile.
How do you say hello in Te Reo Māori? Kia ora - Hello Mōrena - Good morning Tēnā koe - Hello to one person Kia ora/Tēna kōrua - Hello to two people Kia ora tātou/kia ora koutou - Hello everyone Tēnā koutou - Greetings to you (said to three or more people) Nau mai, haere mai - Welcome Kei te pēhea koe? - How are you?
Headings are crucial for organizing your documentation and improving readability. Here’s how to structure them effectively:
Project Documentation
Use headings to organize project information, installation guides, and usage instructions.
Component Documentation
Document individual components, their props, and usage examples.
API Documentation
Detail endpoints, parameters, and response formats.
Version Notes
Track changes and updates in your documentation.
Text Formatting
Basic Formatting
Regular text can be enhanced with bold text for emphasis, italics for secondary emphasis, and inline code for technical terms.
Code Blocks
// Example of a JavaScript function
function greetUser(name) {
return `Hello, ${name}! Welcome to our documentation.`;
}
Blockquotes
Use blockquotes to highlight important notes, warnings, or quotes from team members.
Multiple paragraphs can be included in blockquotes for longer explanations or important sections.
Lists and Organization
Ordered Lists
- Perfect for step-by-step guides
- Installation instructions
- Tutorial sequences
Unordered Lists
- Feature highlights
- Component properties
- Configuration options
Media Integration
Images
Embedded Content
YouTube Tutorial
Social Media Integration
Wow, awesome new @QwikDev + @tailwindcss free template by @onwidget 👏
— Steve (Builder.io) (@Steve8708) December 2, 2022
🌙 Dark mode
🏎️ Killer performance
⚡ Image & font optimization
This community is so amazinghttps://t.co/XT0eLHmAw0 pic.twitter.com/wWGiqgo8gS
Video Presentations
Component Integration
Custom Components
Tables
| Feature | Basic | Pro | Enterprise |
|---|---|---|---|
| Components | ✓ | ✓ | ✓ |
| Templates | 10 | 50 | Unlimited |
| Support | Priority | 24/7 | |
| Custom Domains | 1 | 5 | Unlimited |
Advanced Formatting
Definition Lists
- Markdown
- A lightweight markup language for creating formatted text.
- Front Matter
- Metadata section at the start of markdown files.
Keyboard Commands
Use Ctrl + C to copy text.
Abbreviations
The HTML specification is maintained by the W3C.
_[HTML]: HyperText Markup Language _[W3C]: World Wide Web Consortium
Remember: Good documentation is crucial for project success and team collaboration.