Aperçu README Markdown et édition via le navigateur
Utilisez ce guide lorsqu'un espace de travail Markdown orienté navigateur constitue le moyen le plus rapide de rédiger, prévisualiser et partager du contenu de style README sans quitter la page.
L'éditeur vous offre un aperçu en direct, une vue fractionnée et des préréglages. Il s'agit d'une surface de rédaction et non d'un remplacement pour l'historique ou la révision du référentiel.
Utilisez-le lorsque
Vous avez besoin d’un brouillon README, d’une note de version ou d’un runbook rapide avec un aperçu en direct et sans installation obligatoire de l’éditeur.
Que faut-il inspecter en premier
Vérifiez le mode d'affichage, prévisualisez le rendu et partagez l'état ensemble avant de supposer que le Markdown lui-même est le problème.
Garde-corps
Les brouillons restent dans le stockage du navigateur sur cet appareil. La suppression des données du site les perd et rien n'entre dans une URL tant que vous n'avez pas copié un lien de partage.
Aperçu du fichier README
Commencez à partir d'un préréglage README lorsque vous avez besoin d'une structure de titre avant d'écrire les derniers détails.
# Project Overview
## Install
## Usage
Notes de version
Utilisez un brouillon de note de version lorsque le travail présente des modifications de format claires pour que les lecteurs puissent les numériser rapidement.
# Release Notes
- Added safer share handling
- Fixed layout regressions
Dossier d'exploitation des incidents
Passez à un modèle de runbook lorsque le Markdown deviendra un guide opérationnel au lieu d'une copie marketing.
## Triage
1. Confirm impact
2. Capture rollback window
3. Share updates
L'éditeur Markdown est plus puissant lorsque vous avez besoin d'un brouillon rapide, d'un aperçu en direct et d'un comportement de partage contrôlé sans passer à une pile de création plus lourde.
- Utilisez d’abord la vue fractionnée pour que la source et la sortie rendue restent visibles ensemble.
- Traitez le stockage de brouillons locaux et les URL de partage explicites comme des flux de travail distincts.
Les liens prédéfinis peuvent être partagés largement en toute sécurité, tandis que les projets d'URL explicites ne doivent être copiés que lorsque le corps exact de Markdown doit voyager.
- Si le brouillon est trop volumineux pour une URL, continuez à utiliser le flux de travail du navigateur local au lieu de le forcer à passer à l'état de partage.
- Utilisez diff lorsque la portée de la révision compare deux révisions de documentation, sans prévisualiser un brouillon actif.