Werbung

← Alle Anleitungen

Technische Dokumentation stylen

Perfekte Einstellungen für Code und API-Dokumentation

Überblick

Technische Dokumentation hat einzigartige Anforderungen: klare Codeblock-Präsentation, Syntaxhervorhebung und Monospace-Schriften, die Code von Prosa unterscheiden.

Velvet MD zeichnet sich beim Rendern von README-Dateien, API-Dokumentation und Code-lastigen Tutorials aus.

Beispiel für technische Dokumentation

Sehen Sie, wie die Terminal-Vorlage eine Installationsanleitung rendert:

Markdown
# 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.
Terminal Template

Installation Guide

Prerequisites

  • Node.js 18+
  • npm or yarn

Quick Start

npm install @mylib/core

Basic Usage

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.

Warum es technisch aussieht

Die Terminal-Vorlage erzeugt ein entwicklerfreundliches Erscheinungsbild durch spezifische Designentscheidungen:

  • Monospace-Schriften — Code erscheint mit konsistenter Zeichenbreite für einfaches Lesen
  • Syntaxhervorhebung — Schlüsselwörter, Strings und Kommentare sind farbcodiert für schnelles Überfliegen
  • Dunkler Hintergrund — Passt zur Terminal/IDE-Umgebung, mit der Entwickler vertraut sind
  • Kompakter Abstand — Mehr Inhalt passt auf den Bildschirm, weniger Scrollen beim Nachschlagen

Empfohlene Vorlagen

Diese Vorlagen sind für technische Inhalte optimiert:

API Reference
const api = new API();
Terminal Dunkler Hintergrund mit Monospace-Schriften. Die erste Wahl für Entwicklerdokumentation.
README.md
npm install package
GitHub Vertrauter GitHub README Stil. Perfekt für Open-Source-Projektdokumentation.
Documentation
Code with syntax highlight.
Dark Mode Komfortabel für längere Lesesessions. Reduziert Augenbelastung.

Markdown-Tipps für Dokumentation

Diese Markdown-Funktionen sind für technisches Schreiben unerlässlich:

Umzäunte Codeblöcke

Fügen Sie den Sprachnamen für Syntaxhervorhebung hinzu. Unterstützt über 100 Sprachen.

```javascript
const config = { debug: true };
```
Inline-Code

Umschließen Sie Variablennamen, Funktionen oder Befehle mit Backticks zur Hervorhebung.

Run `npm install` to install dependencies.
Hinweisboxen

Verwenden Sie Blockzitate mit fetten Beschriftungen für Warnungen, Hinweise und Tipps.

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

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

Dokumentieren Sie API-Parameter mit fetten Namen und Inline-Code für Typen.

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

Codeblock-Funktionen

Velvet MD bietet ausgezeichnete Code-Präsentation:

  • Automatische Syntaxhervorhebung für über 100 Sprachen
  • Konfigurierbare Code-Schrift (Fira Code, JetBrains Mono, etc.)
  • Option für abgerundete oder schärfe Codeblock-Ecken
Unterstützte Sprachen

JavaScript, TypeScript, Python, Bash, JSON, HTML, CSS, SQL, Go, Rust, Java, C#, PHP, Ruby, Swift, Kotlin, and more.

Dokumentation exportieren

Wählen Sie basierend darauf, wie die Dokumentation verwendet wird:

  • HTML — Am besten für Hosting auf Websites oder Intranets
  • DOCX — Behält Syntaxhervorhebungsfarben in Word bei

Bereit, Ihre Dokumentation zu stylen?

Beginnen Sie mit der Terminal-Vorlage für ein entwicklerfreundliches Aussehen.

Terminal-Vorlage ausprobieren
Werbung