This is an example of source Markdown that shows several types of HTML content supported in this `.prose` wrapper class.
<div class="bd-example prose">
-# Lorem ipsum dolor sit amet
-Cum sociis natoque penatibus et magnis [dis parturient montes](#), nascetur ridiculus mus. *Aenean eu leo quam.* Pellentesque ornare sem lacinia quam venenatis vestibulum. Sed posuere consectetur est at lobortis. Cras mattis consectetur purus sit amet fermentum.
+# Getting Started with Documentation
+Writing clear and effective documentation is essential for any project. When you create content that others will read and use, [proper formatting](#) makes all the difference. *Good documentation* helps users understand complex concepts quickly and efficiently.
-> Curabitur blandit tempus porttitor. Nullam quis risus eget urna mollis ornare vel eu leo. Nullam id dolor id nibh ultricies vehicula ut id elit.
+> Documentation is a love letter that you write to your future self. Clear writing today saves countless hours of confusion tomorrow.
-Etiam porta **sem malesuada magna** mollis euismod. Cras mattis consectetur purus sit amet fermentum. Aenean lacinia bibendum nulla sed consectetur.
+The foundation of great documentation starts with **understanding your audience** and their needs. Writers should focus on clarity, consistency, and providing practical examples that readers can follow.
## Inline HTML elements
## Heading
-Vivamus sagittis lacus vel augue rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+Effective documentation requires careful attention to structure and flow. When organizing content, consider how readers will navigate through your material and what information they need first. Clear headings help users scan quickly and find relevant sections.
### Code
// > 8
```
-Aenean lacinia bibendum nulla sed consectetur. Etiam porta sem malesuada magna mollis euismod. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa.
+Code examples should be practical and directly related to the concepts being explained. Always test your code snippets to ensure they work as expected before including them in documentation.
### Lists
-Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aenean lacinia bibendum nulla sed consectetur. Etiam porta sem malesuada magna mollis euismod. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.
+When presenting information in lists, consider whether the order matters. Use numbered lists for sequential steps and bullet points for related items that don't require a specific order.
-- Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
-- Donec id elit non mi porta gravida at eget metus.
-- Nulla vitae elit libero, a pharetra augue.
+- Write clear, concise list items that focus on one concept each.
+- Use parallel structure across all items in your list.
+- Keep list items roughly the same length when possible.
-Donec ullamcorper nulla non metus auctor fringilla. Nulla vitae elit libero, a pharetra augue.
+Consistency in formatting helps readers process information more efficiently.
-1. Vestibulum id ligula porta felis euismod semper.
-2. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
-3. Maecenas sed diam eget risus varius blandit sit amet non magna.
+1. Start with the most important information first.
+2. Provide context before diving into technical details.
+3. Include practical examples that readers can apply immediately.
-Cras mattis consectetur purus sit amet fermentum. Sed posuere consectetur est at lobortis.
+Well-structured content makes complex topics more accessible to readers with varying levels of expertise.
-- Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
- - Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
- - Donec id elit non mi porta gravida at eget metus.
- - Nulla vitae elit libero, a pharetra augue.
-- Donec id elit non mi porta gravida at eget metus.
-- Nulla vitae elit libero, a pharetra augue.
+- Document your processes and decisions for future reference.
+ - Include reasoning behind important choices you made.
+ - Note any alternative approaches you considered.
+ - Record lessons learned during implementation.
+- Update documentation regularly as your project evolves.
+- Test documentation with actual users to identify gaps.
-Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.
+Regular maintenance ensures your documentation remains accurate and helpful over time.
<dl>
<dt>HyperText Markup Language (HTML)</dt>
<dd>The programming language used to build advanced Web sites and applications</dd>
</dl>
-Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Nullam quis risus eget urna mollis ornare vel eu leo.
+Technical definitions should be clear and accessible to your target audience. Avoid jargon when simpler terms will convey the same meaning effectively.
### Images
-Quisque consequat sapien eget quam rhoncus, sit amet laoreet diam tempus. Aliquam aliquam metus erat, a pulvinar turpis suscipit at.
+Visual elements enhance understanding by providing concrete examples of abstract concepts. Choose images that directly support your written content rather than serving as mere decoration.
### Tables
-Aenean lacinia bibendum nulla sed consectetur. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+Tables work best for comparing related data points or presenting structured information that benefits from a grid layout.
-| Name | Upvotes | Downvotes |
+| Name | Up-votes | Down-votes |
|---------|---------|-----------|
| Alice | 10 | 11 |
| Bob | 4 | 3 |
| Charlie | 7 | 9 |
| Totals | 21 | 23 |
-Nullam id dolor id nibh ultricies vehicula ut id elit. Sed posuere consectetur est at lobortis. Nullam quis risus eget urna mollis ornare vel eu leo.
+Keep table headers descriptive and consider the reading order when arranging columns. Simple tables are easier to understand and maintain than complex ones.
</div>
projects / thirdparty / bootstrap.git / commitdiff
