Aperçu

La documentation technique a des exigences uniques: présentation claire des blocs de code, coloration syntaxique et polices monospace qui distinguent le code de la prose.

Velvet MD excelle dans le rendu des fichiers README, de la documentation API et des tutoriels riches en code.

Exemple de Documentation Technique

Voyez comment le modèle Terminal rend un guide d'installation:

# Installation Guide

## Prerequisites

- Node.js 18+
- npm or yarn

## Quick Start

```bash
npm install @mylib/core
```

## Basic Usage

```javascript
import { Client } from '@mylib/core';

const client = new Client({
  apiKey: process.env.API_KEY
});

const result = await client.query('data');
console.log(result);
```

> **Note:** Always use environment variables for API keys.

npm install @mylib/core

import { Client } from '@mylib/core';

const client = new Client({
  apiKey: process.env.API_KEY
});

const result = await client.query('data');
console.log(result);

Pourquoi Ça Paraît Technique

Le modèle Terminal crée une apparence conviviale pour les développeurs grâce à des choix de design spécifiques:

• Polices monospace — Le code apparaît avec une largeur de caractères cohérente pour une lecture facile
• Coloration syntaxique — Les mots-clés, chaînes et commentaires sont codés par couleur pour un balayage rapide
• Fond sombre — Correspond à l'environnement terminal/IDE que les développeurs connaissent
• Espacement compact — Plus de contenu tient à l'écran, réduisant le défilement pendant la référence

Modèles Recommandés

Ces modèles sont optimisés pour le contenu technique:

Conseils Markdown pour la Documentation

Ces fonctionnalités markdown sont essentielles pour l'écriture technique:

```javascript
const config = { debug: true };
```

Run `npm install` to install dependencies.

> **Warning:** This action is irreversible.

> **Note:** See the API reference for details.

**Parameters:**
- `apiKey` (string) - Your API key
- `timeout` (number) - Request timeout in ms

Fonctionnalités des Blocs de Code

Velvet MD fournit une excellente présentation du code:

• Coloration syntaxique automatique pour plus de 100 langages
• Police de code configurable (Fira Code, JetBrains Mono, etc.)
• Option de coins arrondis ou nets pour les blocs de code

Exporter la Documentation

Choisissez selon la façon dont la documentation sera utilisée:

• HTML — Meilleur pour l'hébergement sur des sites web ou intranets
• DOCX — Préserve les couleurs de coloration syntaxique dans Word