Bidra till HoloLens-dokumentationen
Välkommen till HoloLens-dokumentationen! Alla artiklar som du skapar eller redigerar på den här lagringsplatsen visas för allmänheten.
HoloLens-dokumentationen publiceras till Microsoft Learn, som använder GitHub-smaksatt Markdown med Markdig-funktioner. Innehållet som du redigerar på den här lagringsplatsen formateras till stiliserade sidor som visas på /hololens
.
Den här sidan beskriver de grundläggande stegen och riktlinjerna för att bidra och länkar till grunderna i Markdown. Tack för ditt bidrag!
Namn på lagringsplats | URL |
---|---|
HoloLens | MicrosoftDocs/HoloLens |
Mixad verklighet | MicrosoftDocs/mixed-reality |
Guide för VR-entusiaster | MicrosoftDocs/mixed-reality/enthusiast-guide |
Om du inte redan har ett måste du skapa ett GitHub-konto.
Anteckning
Om du är anställd på Microsoft länkar du ditt GitHub-konto till ditt Microsoft-alias på Microsoft Open Source-portalen. Gå med i "Microsoft" och "MicrosoftDocs" organisationer.
När du konfigurerar ditt GitHub-konto rekommenderar vi även dessa säkerhetsåtgärder:
- Skapa ett starkt lösenord för ditt GitHub-konto.
- Aktivera tvåfaktorautentisering.
- Spara dina återställningskoder på en säker plats.
- Uppdatera dina offentliga profilinställningar.
- Ange ditt namn och överväg att ange din offentliga e-post till Visa inte min e-postadress.
- Vi rekommenderar att du laddar upp en profilbild eftersom en miniatyrbild visas i Microsoft Learn-artiklar som du bidrar till.
- Om du planerar att använda kommandoraden kan du överväga att konfigurera Git Credential Manager för Windows. På så sätt behöver du inte ange ditt lösenord varje gång du gör ett bidrag.
Publiceringssystemet är kopplat till GitHub, så de här stegen är viktiga. Du visas som antingen författare eller deltagare i varje artikel med ditt GitHub-alias.
Använd följande arbetsflöde för att göra uppdateringar för att en befintlig artikel via GitHub i en webbläsare:
Gå till den artikel som du vill redigera i mappen "hololens".
Välj redigeringsknappen (pennikonen) längst upp till höger.
Detta förgrenar automatiskt en disponibel gren från standardgrenen huvudgrenen.
Redigera innehållet i artikeln enligt grunderna i Markdown.
Uppdatera metadata överst i varje artikel:
- rubrik: Sidrubrik som visas på webbläsarfliken när artikeln visas. Sidrubriker används för SEO och indexering, så ändra inte rubriken om det inte behövs (även om detta är mindre viktigt innan dokumentationen blir offentlig).
- beskrivning: Skriv en kort beskrivning av artikelns innehåll, vilket ökar SEO och identifiering.
- författare: Om du är den primära ägaren av sidan lägger du till ditt GitHub-alias här.
- ms.author: Om du är den primära ägaren av sidan lägger du till ditt Microsoft-alias här (du behöver inte @microsoft.com, bara aliaset).
- ms.date: Uppdatera datumet om du lägger till huvudinnehåll på sidan, men inte för korrigeringar som förtydligande, formatering, grammatik eller stavning.
- nyckelord: Nyckelord stöd i SEO (sökmotoroptimering). Lägg till nyckelord, avgränsade med ett kommatecken och ett blanksteg, som är specifika för din artikel, men ingen skiljetecken efter det sista nyckelordet i listan. Du behöver inte lägga till globala nyckelord som gäller för alla artiklar, eftersom de hanteras någon annanstans.
När du har slutfört dina artikelredigeringar rullar du nedåt och väljer Föreslå filändring.
På nästa sida väljer du Skapa pull-begäran för att sammanfoga din automatiskt skapade gren till standardgrenen, huvud-.
Upprepa stegen ovan för nästa artikel som du vill redigera.
Om ändringen byter namn på eller tar bort en befintlig artikel måste du lägga till en omdirigering. På så sätt hamnar alla som har en länk till den befintliga artikeln fortfarande på rätt plats. Omdirigeringar hanteras av .openpublishing.redirection.json-filen i roten på lagringsplatsen.
Lägg till en omdirigering till .openpublishing.redirection.jsongenom att lägga till en post i matrisen redirections
:
{
"redirections": [
{
"source_path": "hololens/old-article",
"redirect_url": "/base-url/new-article#section-about-old-topic",
"redirect_document_id": false
},
source_path
är den relativa lagringsplatsens sökväg till den gamla artikeln som du tar bort. Kontrollera att sökvägen börjar med dokumentuppsättningen (i det här fallethololens
) och innehåller filnamnstillägget.md
.redirect_url
är den relativa offentliga URL:en från den gamla artikeln till den nya artikeln. Se till att den här URL:en inte innehåller.md
och börjar med/
, eftersom den refererar till den offentliga URL:en och inte lagringsplatsens sökväg. Det är tillåtet att länka till ett avsnitt i den nya artikeln med hjälp av#section
. Du kan också använda en absolut sökväg till en annan webbplats här, om det behövs.redirect_document_id
anger om du vill behålla dokument-ID:t från föregående fil. Standardvärdet ärfalse
. Användtrue
om du vill bevara attributetms.documentid
från den omdirigerade artikeln. Om du bevarar dokument-ID:t överförs data, till exempel sidvisningar och rangordningar, till målartikeln. Gör detta om omdirigeringen främst är ett namnbyte och inte en pekare till en annan artikel som bara täcker en del av samma innehåll.
Om du lägger till en omdirigering måste du också ta bort den gamla filen.
Använd följande arbetsflöde för att skapa nya artiklar i dokumentationsdatabasen via GitHub i en webbläsare:
Skapa en förgrening av standardgrenen, main, för MicrosoftDocs/hololens med hjälp av knappen Fork längst upp till höger.
I mappen "hololens" väljer du Skapa ny fil längst upp till höger.
Skapa ett sidnamn för artikeln (använd bindestreck i stället för blanksteg och använd inte skiljetecken eller apostrofer) och lägg till ".md"
Viktigt
Se till att du skapar den nya artikeln från mappen "hololens". Du kan bekräfta detta genom att söka efter "/hololens/" på den nya filnamnsraden.
Lägg till följande metadatablock överst på den nya sidan:
--- title: description: author: ms.author: ms.date: ms.topic: article keywords: ---
Fyll i relevanta metadatafält enligt beskrivningen tidigare i Redigera en befintlig artikel.
Skriva artikelinnehåll med hjälp av grunderna i Markdown.
Lägg till ett
## See also
avsnitt längst ned i artikeln med länkar till andra relevanta artiklar.När du är klar väljer du Checka in ny fil.
Välj Ny pull-begäran och sammanfoga förgreningens huvudgren till MicrosoftDocs/hololens huvud (kontrollera att pilen pekar på rätt mål).
Följande resurser hjälper dig att lära dig hur du redigerar dokumentation med hjälp av Markdown-språket:
På grund av hur tabeller utformas i Microsoft Learn har de inte kantlinjer eller anpassade format, även om du provar infogad CSS. Det verkar fungera under en kort tid, men så småningom kommer plattformen att ta bort stylingen ur tabellen. Så planera framåt och håll dina tabeller enkla. Här är en webbplats som gör Markdown-tabeller enkla: [Tabellgenerator]](https://www.tablesgenerator.com/markdown_tables).
Docs Markdown-tillägget för Visual Studio Code gör det också enkelt att skapa tabeller om du använder Visual Studio Code (se nedan) för att redigera dokumentationen.
Du måste ladda upp dina bilder till mappen "hololens/images" på lagringsplatsen och sedan referera till dem på rätt sätt i artikeln. Bilder visas automatiskt i full storlek, vilket innebär att stora bilder fyller hela artikelns bredd. Vi rekommenderar att du i förväg ändrar storlek på bilderna innan du laddar upp dem. Den rekommenderade bredden är mellan 600 och 700 bildpunkter, men du bör ändra storlek uppåt eller nedåt om det är en tät skärmbild eller en bråkdel av en skärmbild.
Viktigt
Du kan bara ladda upp bilder till din förgrenade lagringsplats innan du sammanfogar. Om du planerar att lägga till bilder i en artikel måste du därför använda Visual Studio Code för att lägga till bilderna i förgreningsmappen "images" först eller kontrollera att du har gjort följande i en webbläsare:
- Förgrenade lagringsplatsen MicrosoftDocs/hololens.
- Redigerade artikeln i din förgrening.
- De bilder som du refererar till i artikeln har laddats upp till mappen "hololens/images" i din förgrening.
- Skapade en pull-begäran för att sammanfoga din förgrening till MicrosoftDocs/hololens huvudgrenen.
Om du vill lära dig hur du konfigurerar en egen förgrenad lagringsplats följer du anvisningarna för att skapa en ny artikel.
När du redigerar i GitHub via en webbläsare kan du välja fliken Förhandsversion längst upp på sidan för att förhandsgranska ditt arbete innan du genomför.
Anteckning
Förhandsgranskning av dina ändringar på Microsoft Learn är endast tillgängligt för Microsoft-anställda.
Microsoft-anställda: När dina bidrag har sammanfogats i standardgrenen kan du huvudsakligagranska innehållet innan det blir offentligt på </hololens?branch=main>. Hitta din artikel med hjälp av innehållsförteckningen i den vänstra kolumnen.
Redigering i webbläsaren är det enklaste sättet att göra snabba ändringar, men det finns några nackdelar:
- Du får ingen stavningskontroll.
- Du får ingen smart länkning till andra artiklar (du måste skriva artikelns filnamn manuellt).
- Det kan vara jobbigt att ladda upp och referera till bilder.
Om du inte vill hantera dessa problem använder du en skrivbordsklient som Visual Studio Code- med ett par användbara tillägg när du bidrar.
Av de orsaker som anges ovankanske du föredrar att använda en skrivbordsklient för att redigera dokumentationen i stället för en webbläsare. Vi rekommenderar att du använder Visual Studio Code.
Följ dessa steg för att konfigurera Visual Studio Code så att det fungerar med den här lagringsplatsen:
- I en webbläsare:
- Installera Git för din dator.
- Installera Visual Studio Code.
- Förgrena MicrosoftDocs/hololens om du inte redan har gjort det.
- I förgreningen väljer du Klona eller laddar ned och kopierar URL:en.
- Skapa en lokal klon av din förgrening i Visual Studio Code:
- På menyn Visa väljer du kommandopaletten.
- Skriv "Git: Clone".
- Klistra in url:en som du kopierade.
- Välj var klonen ska sparas på datorn.
- Välj Öppna lagringsplats i popup-fönstret.
Använd följande arbetsflöde för att göra ändringar i dokumentationen med Visual Studio Code:
Anteckning
All vägledning för redigering och att skapa artiklar och grunderna för att redigera Markdownovan gäller även när du använder Visual Studio Code.
Kontrollera att din klonade förgrening är uppdaterad med den officiella lagringsplatsen.
I en webbläsare skapar du en pull-begäran om att synkronisera de senaste ändringarna från andra deltagare i standardgrenen MicrosoftDocs/hololens, huvudsakliga, till din förgrening (kontrollera att pilen pekar på rätt mål).
I Visual Studio Code väljer du synkroniseringsknappen för att synkronisera din nyligen uppdaterade förgrening till den lokala klonen.
Skapa eller redigera artiklar på den klonade lagringsplatsen med Hjälp av Visual Studio Code.
Redigera en eller flera artiklar (lägg till bilder i mappen "images" om det behövs).
Spara ändringar i Explorer.
Checka in alla ändringar i Källkontroll (skriv incheckningsmeddelande när du uppmanas att göra det).
Välj knappen synkronisera för att synkronisera dina ändringar tillbaka till ursprunget (din förgrening på GitHub).
I en webbläsare skapar du en pull-begäran för att synkronisera nya ändringar i din förgrening tillbaka till MicrosoftDocs/hololens huvud (kontrollera att pilen pekar på rätt mål).
Följande Visual Studio Code-tillägg är användbara när du redigerar dokumentationen:
Docs Markdown-tillägget för Visual Studio Code – Använd Alt+M- för att ta fram en meny med Redigeringsalternativ för Microsoft Learn som:
- Sök och referera till bilder som du har laddat upp.
- Lägg till formatering som listor, tabeller och bildtexter som
>[!NOTE]
. - Sök och referera till interna länkar och bokmärken (länkar till specifika avsnitt på en sida).
- Formateringsfel är markerade (hovra musen över felet om du vill veta mer).
stavningskontroll för kod – felstavade ord understryks. högerklicka på ett felstavat ord för att ändra det eller spara det i ordlistan.