TechDoc helps you to leverage a rich set of markdown features to enhance your documents, making them not only more attractive but also easier to navigate and understand.

With a variety of formatting options, you can create well-structured and visually appealing documentation effortlessly.

Bullet List

Bullet Lists in TechDoc

Bullet lists make content clear, structured, and easy to scan. They help highlight key points independently, improving readability and organization. Ideal for unordered lists, they ensure important details stand out.

Example:

• Easy Document Creation

• Seamless Collaboration

• Integrated API Testing

Numbered List

Numbered lists provide a clear and structured format for presenting step-by-step instructions or sequential information. When order matters, numbered lists help you present sequential steps:

Example:

1. Sign up for TechDoc.

2. Create your first workspace.

3. Start adding pages and collections.

Task List

Task lists combine clarity with functionality by incorporating checkboxes that track progress. Task lists are perfect for tracking progress and to-dos:

Example:

• Lunch

• Homework

• Exercise

Quotes

In TechDoc documentation, quotes let you spotlight essential insights or expert advice, adding depth and credibility to your content. They break up the text, guiding readers to the most critical takeaways in your documentation.

Example:

"Documentation is not just about writing; it's about conveying ideas effectively."

Images

Images in TechDoc documentation enhance clarity by providing visual context that complements your written explanations. They simplify complex technical concepts, making your documentation easier to understand.

Videos

Videos in TechDoc bring your documentation to life by offering dynamic, interactive demonstrations of technical processes. They provide step-by-step visual guidance, ensuring that your audience grasps even the most intricate details with ease.

Files

Link files directly for users to download additional resources:

Example:

Breadcrumbs

Breadcrumbs provide navigational context, showing the user's current location within your document hierarchy:

Example:

Home > TechDoc Docs > Getting Started

This simple navigation trail improves the user experience by clearly indicating the path back to higher-level pages.

Callouts

Callouts are used to draw attention to important information, warnings, or tips:

Example:

Horizontal Rule

A horizontal rule can be used to create a visual separation between different sections of your document, improving readability

Example:

Code Block

Code Block help you display code snippets clearly, with optional syntax highlighting:

**Example:**
```python
def greet():
    print("Welcome to TechDoc!")

Code Block are essential for technical documentation, especially when explaining code or configuration examples.

Link To Page

The "Link To Page" feature allows you to quickly link to other pages and subpages within your documentation. This makes it easier for users to navigate between related sections.

How it works: When you use the "Link To Page" option, a list of all pages and subpages will appear, allowing you to select the one you want to reference.