spool-hubBlogartikelen

Lees repositorydocumentatie in de app

nieuwsa-686

Een gestroomlijnde digitale bibliotheek en documentatieverkenner, abstracte weergave met overzichtelijke mappen en tekstdocumenten

Wat het is

De Documenten-verkenner (Docs explorer) is een ingebouwde viewer voor de markdown-bestanden van uw repository. Geplaatst onder 'Help' op de linkerbalk, rendert deze readmes, specificaties en andere .md-bestanden rechtstreeks in de app.

Waarom het gebruiken

Het elimineert de noodzaak om uw werkruimte te verlaten of naar een externe bron zoals GitHub te gaan om projectdocumentatie te lezen. Alle bestanden worden weergegeven in het native thema van de app.

Hoe het te gebruiken

Klik op het Documenten-icoon. Op brede schermen opent de verkenner in twee panelen: een interactieve mappenstructuur aan de linkerkant en de documentviewer aan de rechterkant. U kunt mappen uitvouwen om documenten te vinden of op koppelingen in documenten klikken om te navigeren. Op een telefoon ziet u een enkele kolom met een knop 'Mappen' om de verkenner boven het document in of uit te schakelen. U kunt eenvoudig links delen, aangezien URL's de structuur /docs/<repo path> volgen.

De oude manier

Voorheen moesten gebruikers naar de externe repository-host navigeren of lokale ruwe markdown-bestanden openen om projectdocumentatie te bekijken.

De nieuwe manier

Documenten worden nu geparseerd en fraai weergegeven binnen de werkruimte. De viewer ondersteunt relatieve routering voor links tussen bestanden en behoudt uw positie intuïtief.