Dokumentacja języka Markdown dla języka Learn
Ten artykuł zawiera alfabetyczne informacje dotyczące pisania języka Markdown dla usługi Microsoft Learn.
Markdown to lekki język znaczników ze składnią formatowania zwykłego tekstu. Platforma Microsoft Learn obsługuje kod Markdown zgodny ze standardem CommonMark analizowany za pośrednictwem aparatu analizowania języka Markdig . Środowisko Microsoft Learn obsługuje również niestandardowe rozszerzenia języka Markdown, które zapewniają bogatszą zawartość w witrynie Microsoft Learn.
Możesz użyć dowolnego edytora tekstów do zapisania języka Markdown, ale zalecamy Visual Studio Code z pakietem Learn Authoring Pack. Pakiet Learn Authoring Pack udostępnia narzędzia do edycji i funkcje w wersji zapoznawczej, które umożliwiają sprawdzenie, jak będą wyglądać artykuły podczas renderowania w usłudze Microsoft Learn.
Alerty (Uwaga, Porada, Ważne, Przestroga, Ostrzeżenie)
Alerty to rozszerzenie języka Markdown do tworzenia cudzysłowów blokowych renderowanych w środowisku Microsoft Learn z kolorami i ikonami wskazującymi znaczenie zawartości.
Unikaj notatek, porad i ważnych pól. Czytelnicy mają tendencję do pomijania ich. Lepiej umieścić te informacje bezpośrednio w tekście artykułu.
Jeśli musisz używać alertów, ogranicz je do jednego lub dwóch na artykuł. Wiele notatek nigdy nie powinno znajdować się obok siebie w artykule.
Obsługiwane są następujące typy alertów:
> [!NOTE]
> Information the user should notice even if skimming.
> [!TIP]
> Optional information to help a user be more successful.
> [!IMPORTANT]
> Essential information required for user success.
> [!CAUTION]
> Negative potential consequences of an action.
> [!WARNING]
> Dangerous certain consequences of an action.
Te alerty wyglądają następująco w witrynie Microsoft Learn:
Uwaga
Information the user should notice even if skimming.
Porada
Optional information to help a user be more successful.
Ważne
Essential information required for user success.
Przestroga
Negative potential consequences of an action.
Ostrzeżenie
Niektóre niebezpieczne konsekwencje akcji.
Nawiasy kątowe
Jeśli używasz nawiasów kątowych w tekście w pliku (na przykład w celu oznaczenia symbolu zastępczego), musisz ręcznie zakodować nawiasy kątowe. W przeciwnym razie w języku Markdown nawiasy kątowe zostaną potraktowane jak tag HTML.
Na przykład zakoduj <script name> jako <script name> lub \<script name>.
Nawiasy kątowe nie muszą być ucieczki w postaci tekstu sformatowanego jako kod wbudowany lub bloki kodu.
Apostrofy i cudzysłowy
W przypadku kopiowania z programu Word do edytora języka Markdown tekst może zawierać „eleganckie” (zawinięte) apostrofy lub cudzysłowy. Należy je zakodować lub zmienić na podstawowe apostrofy lub znaki cudzysłowu. W przeciwnym razie po opublikowaniu pliku otrzymasz coś takiego: It’s
Oto sposoby kodowania „eleganckich” wersji tych znaków interpunkcyjnych:
- Lewy cudzysłów (otwierający):
“ - Prawy cudzysłów (zamykający):
” - Prawy pojedynczy cudzysłów lub apostrof (zamykający):
’ - Lewy pojedynczy cudzysłów (otwierający) (rzadko używany):
‘
Porada
Aby uniknąć "inteligentnych" znaków w plikach języka Markdown, należy opierać się na funkcji zamiany inteligentnego cudzysłowu pakietu Learn Authoring Pack. Aby uzyskać więcej informacji, zobacz zamiana cudzysłowu inteligentnego.
Cytaty
Do tworzenia cytatu blokowego służy znak >:
> This is a blockquote. It is usually rendered indented and with a different background color.
Powyższy przykład zostanie wyrenderowany następująco:
Jest to blockquote. Zwykle jest renderowany wcięcie i ma inny kolor tła.
Tekst pogrubiony i kursywa
Aby sformatować tekst jako pogrubiony, należy je umieścić w dwóch gwiazdkach:
This text is **bold**.
Aby sformatować tekst jako kursywę, należy je ująć w jedną gwiazdkę:
This text is *italic*.
Aby sformatować tekst jako pogrubiony i kursywę, należy je ująć w trzy gwiazdki:
This text is both ***bold and italic***.
Aby uzyskać wskazówki dotyczące używania tekstu pogrubionego i kursywowego, zobacz wytyczne dotyczące formatowania tekstu.
Fragmenty kodu
Język Markdown obsługuje umieszczanie fragmentów kodu w tekście w zdaniu i jako oddzielny blok "ogrodzony" między zdaniami. Aby uzyskać więcej informacji, zobacz How to add code to docs (Jak dodać kod do dokumentów).
Kolumny
Rozszerzenie Markdown kolumn daje autorom możliwość dodawania układów zawartości opartych na kolumnach, które są bardziej elastyczne i zaawansowane niż podstawowe tabele języka Markdown, które są odpowiednie tylko dla prawdziwych danych tabelarycznych. Możesz dodać maksymalnie cztery kolumny i użyć opcjonalnego span atrybutu, aby scalić co najmniej dwie kolumny.
Rozszerzenie kolumn nadal działa, ale nie zalecamy już tworzenia układów niestandardowych. Odkryliśmy, że wiele niestandardowych układów kolumn ma problemy z ułatwieniami dostępu lub w inny sposób narusza wytyczne dotyczące stylu. Nie twórz układów niestandardowych. Użyj standardowych funkcji platformy Microsoft Learn.
Składnia kolumn jest następująca:
:::row:::
:::column span="":::
Content...
:::column-end:::
:::column span="":::
More content...
:::column-end:::
:::row-end:::
Kolumny powinny zawierać tylko podstawowe znaczniki Markdown, w tym obrazy. Nagłówki, tabele, karty i inne złożone struktury nie powinny być uwzględniane. Wiersz nie może mieć żadnej zawartości poza kolumną.
Na przykład następujący kod Markdown tworzy jedną kolumnę, która obejmuje dwie szerokości kolumn i jedną kolumnę standardową (bez span):
:::row:::
:::column span="2":::
**This is a 2-span column with lots of text.**
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vestibulum mollis nunc
ornare commodo. Nullam ac metus imperdiet, rutrum justo vel, vulputate leo. Donec
rutrum non eros eget consectetur.
:::column-end:::
:::column span="":::
**This is a single-span column with an image in it.**
:::column-end:::
:::row-end:::
Renderowanie zostanie przeprowadzone w następujący sposób:
Jest to 2-zakresowa kolumna z dużą ilością tekstu.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vestibulum mollis nunc ornare commodo. Nullam ac metus imperdiet, rutrum justo vel, vulputate leo. Donec rutrum non eros eget consectetur.
Jest to kolumna z jednym zakresem z obrazem w nim.
Komentarze
Usługa Microsoft Learn obsługuje komentarze HTML, jeśli musisz dodać komentarz do sekcji artykułu:
<!--- Here's my comment --->
Ostrzeżenie
Nie umieszczaj prywatnych ani poufnych informacji w komentarzach HTML. Usługa Microsoft Learn przekazuje komentarze HTML do opublikowanego kodu HTML, który jest publiczny. Chociaż komentarze HTML są niewidoczne dla oka czytelnika, są one widoczne w kodzie HTML poniżej.
Nagłówki
Usługa Microsoft Learn obsługuje sześć poziomów nagłówków języka Markdown:
# This is a first level heading (H1)
## This is a second level heading (H2)
...
###### This is a sixth level heading (H6)
- Między ostatnim znakiem
#i tekstem nagłówka musi być odstęp. - Każdy plik markdown musi mieć jeden i tylko jeden nagłówek H1.
- Nagłówek H1 musi być pierwszą zawartością w pliku po bloku metadanych YML.
- Nagłówki H2 są automatycznie wyświetlane w menu nawigacji po prawej stronie opublikowanego pliku. Nagłówki niższego poziomu nie są wyświetlane, dlatego strategicznie używaj nagłówków H2, aby ułatwić czytelnikom poruszanie się po zawartości.
- Nagłówki HTML, takie jak
<h1>, nie są zalecane, a w niektórych przypadkach będą powodować ostrzeżenia kompilacji. - Możesz połączyć się z poszczególnymi nagłówkami w pliku za pośrednictwem linków zakładki.
HTML
Mimo że język Markdown obsługuje wbudowany kod HTML, kod HTML nie jest zalecany do publikowania w usłudze Microsoft Learn, a z wyjątkiem ograniczonej listy wartości spowoduje błędy kompilacji lub ostrzeżenia.
Obrazy
Domyślnie dla obrazów są obsługiwane następujące typy plików:
- jpg
- png
Aby obsługiwać inne typy obrazów, takie jak .gif, należy dodać je jako zasoby w pliku docfx.json:
"resource": [
{
"files" : [
"**/*.png",
"**/*.jpg,
"**/*.gif"
],
Standardowe obrazy koncepcyjne (domyślny język Markdown)
Podstawowa składnia języka Markdown do osadzania obrazu to:
Example:
Gdzie element <alt text> jest krótkim opisem obrazu, a element <folder path> jest ścieżką względną do obrazu. Alternatywny tekst jest wymagany na potrzeby czytników zawartości ekranu dla osób niedowidzących. Jest to również przydatne, jeśli występuje usterka witryny, w której obraz nie może być renderowany.
Podkreślenia w tekście alternatywnym nie są poprawnie renderowane, chyba że unikniesz ich, poprzedzając je ukośnikiem odwrotnym (\_). Nie kopiuj jednak nazw plików do użycia jako tekstu alternatywnego. Na przykład zamiast tego:
Napisz to:
Standardowe obrazy koncepcyjne (Learn Markdown)
Rozszerzenie niestandardowe :::image::: w środowisku Microsoft Learn obsługuje standardowe obrazy, złożone obrazy i ikony.
W przypadku obrazów standardowych starsza składnia języka Markdown będzie nadal działać, ale nowe rozszerzenie jest zalecane, ponieważ obsługuje bardziej zaawansowane funkcje, takie jak określanie zakresu lokalizacji, który różni się od tematu nadrzędnego. Inne zaawansowane funkcje, takie jak wybieranie z galerii obrazów udostępnionych zamiast określania obrazu lokalnego, będą dostępne w przyszłości. Nowa składnia jest następująca:
:::image type="content" source="<folderPath>" alt-text="<alt text>":::
Jeśli type="content" (wartość domyślna) są wymagane zarówno, jak source i alt-text .
Złożone obrazy z długimi opisami
To rozszerzenie umożliwia również dodanie obrazu z długim opisem odczytywanym przez czytniki zawartości ekranu, ale nie jest renderowane wizualnie na opublikowanej stronie. Długie opisy są wymaganiem dotyczącym ułatwień dostępu dla złożonych obrazów, takich jak grafy. Składnia jest następująca:
:::image type="complex" source="<folderPath>" alt-text="<alt text>":::
<long description here>
:::image-end:::
Jeśli type="complex", source, , alt-textdługi opis i :::image-end::: tag są wymagane.
Gdy zmiany są w wersji zapoznawczej lub opublikowane, możesz sprawdzić, czy długi opis istnieje, klikając obraz prawym przyciskiem myszy i wybierając polecenie Sprawdź (w przypadku korzystania z przeglądarki Microsoft Edge, chociaż inne przeglądarki mają podobne funkcje). Ta akcja powoduje przejście do źródła obrazu w kodzie HTML, pod którym znajdziesz wizualnie ukrytą klasę. Rozwiń listę rozwijaną tej klasy i znajdziesz długi opis:
Obramowania automatyczne
Rozszerzenie :::image::: obsługuje border również właściwość , która automatycznie dodaje szare obramowanie 1 pikseli wokół obrazu. Właściwość border jest true domyślnie właściwością content i complex obrazami, więc automatycznie otrzymasz obramowanie, chyba że jawnie dodasz właściwość z wartością false. Właściwość border jest false domyślnie dostępna dla icon obrazów.
Właściwość border jest zalecanym sposobem dodawania obramowania. Nie twórz własnych obramowań ręcznie.
Określanie zakresu lokalizowania
Czasami zakres lokalizacji obrazu różni się od zakresu zawartego w nim artykułu lub modułu. Może to spowodować złe środowisko globalne: na przykład jeśli zrzut ekranu produktu zostanie przypadkowo zlokalizowany w języku, w jakim produkt jest niedostępny. Aby temu zapobiec, można określić opcjonalny loc-scope atrybut na obrazach typów content i complex, i jest wymagany dla zrzutów ekranu pokazujących produkt z innym zakresem lokalizacji niż artykuł lub moduł, który go zawiera.
Ikony
Rozszerzenie obrazu obsługuje ikony, które są obrazami dekoracyjnym i nie powinny mieć tekstu alternatywnego. Składnia ikon to:
:::image type="icon" source="<folderPath>":::
Jeśli type="icon"parametr należy określić, source ale alt-text nie powinien być.
Właściwość border jest false domyślnie dostępna dla ikon. Jeśli obraz dekoracyjny wymaga standardowego obramowania obrazu, jawnie dodaj border="true" go do tagu :::image::: .
Dołączone pliki markdown
Jeśli pliki markdown muszą być powtarzane w wielu artykułach, można użyć pliku dołączania. Funkcja dołączania powoduje, że środowisko Microsoft Learn zastąpi odwołanie zawartością pliku dołączanego w czasie kompilacji. Można użyć funkcji w następujący sposób:
- Wbudowane: użyj ponownie wspólnego fragmentu kodu tekstowego w tekście z tekstem w zdaniu.
- Blokowe: wielokrotne użycie całego pliku Markdown jako bloku zagnieżdżonego w sekcji artykułu.
Wbudowany lub blokowy plik dołączania jest plikiem Markdown (md). Może on zawierać dowolny prawidłowy kod w języku Markdown. Pliki dołączania są zwykle zlokalizowane w typowym podkatalogu dołączania w katalogu głównym repozytorium. Podczas publikowania artykułu dołączany plik jest płynnie z nim integrowany.
Zawiera składnię
Pozycja Dołączanie bloków znajduje się we własnym wierszu:
[!INCLUDE [<title>](<filepath>)]
Wbudowany element include znajduje się w wierszu:
Text before [!INCLUDE [<title>](<filepath>)] and after.
Gdzie <title> jest nazwą pliku i <filepath> jest ścieżką względną do pliku.
INCLUDE musi być wielkich liter i musi znajdować się spacja przed znakiem <title>.
Poniżej przedstawiono wymagania i uwagi dotyczące plików dołączanych:
- Blokowe operacje dołączania są używane w przypadku znaczących ilości zawartości — akapitu lub dwóch, procedury udostępnianej lub sekcji udostępnianej. Nie używaj ich do niczego mniejszego niż zdanie.
- Funkcje Dołączania nie będą renderowane w widoku renderowanego w usłudze GitHub artykułu, ponieważ korzystają one z rozszerzeń microsoft Learn. Będą one renderowane tylko po publikacji.
- Napisz cały tekst w pliku dołączania w pełnych zdaniach lub frazach, które nie zależą od poprzedniego lub następującego tekstu w artykule, który odwołuje się do dołączania. Ignorowanie tych wskazówek powoduje utworzenie nieprzetłumaczalnego ciągu w artykule.
- Nie osadzaj plików dołączanych w innych plikach dołączanych.
-
/Includesfoldery są wykluczone z kompilacji. W związku z tym obrazy przechowywane w/includesfolderach i przywoływalne w dołączonych plikach nie będą wyświetlane w opublikowanej zawartości. Przechowywanie obrazów w/mediafolderze poza folderem/includes. - Podobnie jak w przypadku zwykłych artykułów nie należy udostępniać multimediów między dołączanymi plikami. Użyj oddzielnego pliku z unikatową nazwą dla każdego dołączenia i artykułu. Plik multimedialny należy przechowywać w folderze media skojarzonym z dołączeniem.
- Nie należy używać dołączenia jako jedynej zawartości artykułu. Operacje dołączania mają stanowić uzupełnienie pozostałej zawartości artykułu.
Wcięcie
W języku Markdown spacje przed pierwszym znakiem wiersza określają wyrównanie wiersza względem poprzednich wierszy. Wcięcie ma szczególnie wpływ na listy numerowane i punktowane w celu renderowania wielu poziomów zagnieżdżania w formacie hierarchicznym lub konspektu.
Aby wcięć tekst w celu wyrównania do poprzedniego akapitu lub elementu na liście numerowanej lub punktowanej, użyj spacji.
W poniższych dwóch przykładach pokazano, jak wcięcia akapitów są renderowane na podstawie ich relacji z innymi akapitami.
1. This is a numbered list example (one space after the period before the letter T).
This sentence is indented three spaces.
This code block is indented three spaces.
- This is a bulleted list example (one space after the bullet before the letter T).
This sentence is indented two spaces.
> [!TIP]
> This tip is indented two spaces.
- This is a second-level bullet (indented two spaces, with one space after the bullet before the letter T).
This sentence is indented four spaces.
> This quote block is indented four spaces.
Powyższy przykład jest renderowany jako:
Jest to przykład listy numerowanej (jedną spację po kropce przed literą T).
To zdanie ma wcięcie z trzema spacjami.
This code block is indented three spaces.
Jest to przykład listy punktowanej (jedna spacja po punktorze przed literą T).
To zdanie ma wcięcie dwóch spacji.
Porada
Ta wskazówka jest wcięciem dwóch spacji.
Jest to punktor drugiego poziomu (wcięty dwa spacje, z jedną spacją po punktorze przed literą T).
To zdanie ma wcięcie czterech spacji.
Ten blok cudzysłowu ma wcięcie czterech spacji.
Linki
Aby uzyskać informacje na temat składni linków, zobacz Używanie linków w dokumentacji.
Listy (numerowana, punktowana, kontrolna)
Lista numerowana
Aby utworzyć listę numerowaną, możesz użyć wszystkich 1s. Liczby są renderowane w kolejności rosnącej jako lista sekwencka po opublikowaniu. Aby zwiększyć czytelność źródła, można ręcznie zwiększyć liczbę list.
Nie używaj liter na listach, w tym list zagnieżdżonych. Nie są one poprawnie renderowane po opublikowaniu w środowisku Microsoft Learn. Listy zagnieżdżone używające numerów po opublikowaniu będą renderowane jako małe litery. Na przykład:
1. This is
1. a parent numbered list
1. and this is
1. a nested numbered list
1. (fin)
Renderowanie zostanie przeprowadzone w następujący sposób:
- This is
- a parent numbered list
- and this is
- a parent numbered list
- (fin)
Lista punktowana
Aby utworzyć listę punktowaną, użyj - lub * wykonaj spację na początku każdego wiersza:
- This is
- a parent bulleted list
- and this is
- a nested bulleted list
- All done!
Renderowanie zostanie przeprowadzone w następujący sposób:
- This is
- a parent bulleted list
- and this is
- a nested bulleted list
- All done!
Niezależnie od używanej - składni lub *, użyj jej spójnie w artykule.
Lista kontrolna
Listy kontrolne są dostępne do użycia w usłudze Microsoft Learn za pośrednictwem niestandardowego rozszerzenia języka Markdown:
> [!div class="checklist"]
> * List item 1
> * List item 2
> * List item 3
Ten przykład jest renderowany w witrynie Microsoft Learn w następujący sposób:
- Element listy 1
- Element listy 2
- Element listy 3
Użyj list kontrolnych na początku lub na końcu artykułu, aby podsumować zawartość „Czego się nauczysz” lub „Co już wiesz”. Nie dodawaj przypadkowych list kontrolnych w swoich artykułach.
Akcja w następnym kroku
Możesz użyć rozszerzenia niestandardowego, aby dodać przycisk akcji na następne kroki do stron usługi Microsoft Learn.
Składnia wygląda następująco:
> [!div class="nextstepaction"]
> [button text](link to topic)
Na przykład:
> [!div class="nextstepaction"]
> [Learn about adding code to articles](code-in-docs.md)
Renderowanie zostanie przeprowadzone w następujący sposób:
W akcji Następny krok możesz użyć dowolnego obsługiwanego linku, w tym linku języka Markdown do innej strony internetowej. W większości przypadków następnym linkiem akcji będzie link względny do innego pliku w tym samym zestawie dokumentów.
Ciągi nielokalizowane
Możesz użyć niestandardowego no-loc rozszerzenia języka Markdown, aby zidentyfikować ciągi zawartości, które mają być ignorowane przez proces lokalizacji.
Wszystkie wywoływane ciągi będą uwzględniane wielkości liter; oznacza to, że ciąg musi być dokładnie zgodny, aby był ignorowany dla lokalizacji.
Aby oznaczyć pojedynczy ciąg jako nielokalizowalny, użyj tej składni:
:::no-loc text="String":::
Na przykład w następujących przypadkach tylko pojedyncze wystąpienie Document obiektu zostanie zignorowane podczas procesu lokalizacji:
# Heading 1 of the Document
Markdown content within the :::no-loc text="Document":::. The are multiple instances of Document, document, and documents.
Uwaga
Użyj \ polecenia , aby uciec od znaków specjalnych:
Lorem :::no-loc text="Find a \"Quotation\""::: Ipsum.
Możesz również użyć metadanych w nagłówku YAML, aby oznaczyć wszystkie wystąpienia ciągu w bieżącym pliku Markdown jako nielokalizowalne:
author: cillroy
no-loc: [Global, Strings, to be, Ignored]
Uwaga
Metadane no-loc nie są obsługiwane jako metadane globalne w pliku docfx.json . Potok lokalizacji nie odczytuje pliku docfx.json , dlatego metadane lokalizacji nie muszą być dodawane do każdego pojedynczego pliku źródłowego.
W poniższym przykładzie zarówno w metadanych title , jak i nagłówku języka Markdown wyraz Document zostanie zignorowany podczas procesu lokalizacji.
W metadanych description i głównej zawartości języka Markdown słowo document jest zlokalizowane, ponieważ nie zaczyna się od kapitału D.
---
title: Title of the Document
author: author-name
description: Description for the document
no-loc: [Title, Document]
---
# Heading 1 of the Document
Markdown content within the document.
Selektory
Selektory to elementy interfejsu użytkownika, które umożliwiają użytkownikowi przełączanie się między wieloma odmianami tego samego artykułu. Są one używane w niektórych zestawach dokumentacji, aby rozwiązać różnice w implementacji między technologiami lub platformami. Selektory są zwykle najbardziej odpowiednie dla naszej zawartości platformy mobilnej dla deweloperów.
Ponieważ ten sam selektor języka Markdown znajduje się w każdym pliku artykułu, który używa selektora, zalecamy umieszczenie selektora dla artykułu w pliku dołączania. Następnie możesz odwołać się do tego pliku dołączanego we wszystkich plikach artykułów, które używają tego samego selektora.
Istnieją dwa typy selektorów: pojedynczy selektor i selektor wielokrotny.
Pojedynczy selektor
> [!div class="op_single_selector"]
> - [Universal Windows](../articles/notification-hubs-windows-store-dotnet-get-started/)
> - [Windows Phone](../articles/notification-hubs-windows-phone-get-started/)
> - [iOS](../articles/notification-hubs-ios-get-started/)
> - [Android](../articles/notification-hubs-android-get-started/)
> - [Kindle](../articles/notification-hubs-kindle-get-started/)
> - [Baidu](../articles/notification-hubs-baidu-get-started/)
> - [Xamarin.iOS](../articles/partner-xamarin-notification-hubs-ios-get-started/)
> - [Xamarin.Android](../articles/partner-xamarin-notification-hubs-android-get-started/)
... będzie renderowany w następujący sposób:
Selektor wielokrotny
> [!div class="op_multi_selector" title1="Platform" title2="Backend"]
> - [(iOS | .NET)](./mobile-services-dotnet-backend-ios-get-started-push.md)
> - [(iOS | JavaScript)](./mobile-services-javascript-backend-ios-get-started-push.md)
> - [(Windows universal C# | .NET)](./mobile-services-dotnet-backend-windows-universal-dotnet-get-started-push.md)
> - [(Windows universal C# | Javascript)](./mobile-services-javascript-backend-windows-universal-dotnet-get-started-push.md)
> - [(Windows Phone | .NET)](./mobile-services-dotnet-backend-windows-phone-get-started-push.md)
> - [(Windows Phone | Javascript)](./mobile-services-javascript-backend-windows-phone-get-started-push.md)
> - [(Android | .NET)](./mobile-services-dotnet-backend-android-get-started-push.md)
> - [(Android | Javascript)](./mobile-services-javascript-backend-android-get-started-push.md)
> - [(Xamarin iOS | Javascript)](./partner-xamarin-mobile-services-ios-get-started-push.md)
> - [(Xamarin Android | Javascript)](./partner-xamarin-mobile-services-android-get-started-push.md)
... będzie renderowany w następujący sposób:
Indeks dolny i indeks górny
Należy używać indeksu dolnego lub indeksu górnego tylko wtedy, gdy jest to konieczne, aby uzyskać dokładność techniczną, na przykład podczas pisania o formułach matematycznych. Nie należy ich używać w stylach innych niż standardowe, takich jak przypisy dolne.
W przypadku indeksu dolnego i górnego użyj kodu HTML:
Hello <sub>This is subscript!</sub>
Renderowanie zostanie przeprowadzone w następujący sposób:
Witaj , to jest indeks dolny!
Goodbye <sup>This is superscript!</sup>
Renderowanie zostanie przeprowadzone w następujący sposób:
Pożegnaj to jest indeks górny!
tabelami
Najprostszym sposobem utworzenia tabeli w języku Markdown jest użycie kresek pionowych i wierszy. Aby utworzyć standardową tabelę z nagłówkiem, po pierwszym wierszu wstaw z wiersz w kreskami:
|This is |a simple |table header|
|----------|-----------|------------|
|table |data |here |
|it doesn't|actually |have to line up nicely!|
Renderowanie zostanie przeprowadzone w następujący sposób:
| This is | a simple | table header |
|---|---|---|
| tabela | dane | tutaj |
| it doesn't | actually | have to line up nicely! |
Kolumny można wyrównać za pomocą dwukropków:
| Fun | With | Tables |
| :------------------- | -------------------: |:---------------:|
| left-aligned column | right-aligned column | centered column |
| $100 | $100 | $100 |
| $10 | $10 | $10 |
| $1 | $1 | $1 |
Renderuje się następująco:
| Zabawa | With | tabelami |
|---|---|---|
| kolumna wyrównana do lewej | kolumna wyrównana do prawej | kolumna wyśrodkowana |
| 100 USD | 100 USD | 100 USD |
| 10 USD | 10 USD | 10 USD |
| 1 USD | 1 USD | 1 USD |
Porada
Rozszerzenie Learn Authoring dla programu VS Code ułatwia dodawanie podstawowych tabel języka Markdown.
Możesz również użyć generatora tabeli w trybie online.
Podziały wierszy w wyrazach w dowolnej komórce tabeli
Długie wyrazy w tabeli markdown mogą sprawić, że tabela będzie rozszerzana do prawej nawigacji i staje się nieczytelna. Możesz to rozwiązać, umożliwiając renderowanie automatycznego wstawiania podziałów wierszy w wyrazach w razie potrzeby. Wystarczy zawinąć tabelę przy użyciu niestandardowej klasy [!div class="mx-tdBreakAll"].
Poniżej znajduje się przykładowy kod Markdown dla tabeli z trzema wierszami, która zostanie zawinięta przy użyciu elementu div z nazwą klasy mx-tdBreakAll.
> [!div class="mx-tdBreakAll"]
> |Name|Syntax|Mandatory for silent installation?|Description|
> |-------------|----------|---------|---------|
> |Quiet|/quiet|Yes|Runs the installer, displaying no UI and no prompts.|
> |NoRestart|/norestart|No|Suppresses any attempts to restart. By default, the UI will prompt before restart.|
> |Help|/help|No|Provides help and quick reference. Displays the correct use of the setup command, including a list of all options and behaviors.|
Będzie ona renderowana w następujący sposób:
| Nazwa | Składnia | Obowiązkowy element w przypadku instalacji dyskretnej? | Opis |
|---|---|---|---|
| Quiet | /quiet | Tak | Uruchamia instalatora niewyświetlającego interfejsu użytkownika ani monitów. |
| NoRestart | /norestart | Nie | Pomija wszelkie próby ponownego uruchomienia. Domyślnie interfejs użytkownika wyświetla monit przed ponownym uruchomieniem. |
| Help | /help | Nie | Zapewnia pomoc i szybki dostęp do informacji. Wyświetla informacje na temat poprawnego użycia polecenia konfiguracji, w tym listę wszystkich opcji i zachowań. |
Podziały wierszy w wyrazach w komórkach tabeli drugiej kolumny
Podziały wierszy mogą być automatycznie wstawiane w wyrazach tylko w drugiej kolumnie tabeli. Aby ograniczyć podziały do drugiej kolumny, zastosuj klasę mx-tdCol2BreakAll przy użyciu div składni otoki, jak pokazano wcześniej.
Niespójne szerokości kolumn między tabelami
Możesz zauważyć, że szerokość kolumn tabel w artykułach wygląda dziwnie lub niespójnie. To zachowanie występuje, ponieważ długość tekstu w komórkach określa układ tabeli. Niestety nie ma możliwości kontrolowania sposobu renderowania tabel. Jest to ograniczenie języka Markdown. Mimo że będzie wyglądać ładniej, aby szerokość kolumn tabeli była spójna, byłoby to również pewne wady:
- Przeplot kodu HTML przy użyciu języka Markdown sprawia, że tematy są bardziej skomplikowane i zniechęcają do współtworzenia przez społeczność.
- Tabela, która wygląda dobrze pod kątem określonego rozmiaru ekranu, może w końcu wyglądać nieczytelnie w różnych rozmiarach ekranu, ponieważ wywłaszcza renderowanie dynamiczne.
Tabele macierzy danych
Tabela macierzy danych ma zarówno nagłówek, jak i ważoną pierwszą kolumnę, tworząc macierz z pustą komórką w lewym górnym rogu. Środowisko Microsoft Learn ma niestandardowy kod Markdown dla tabel macierzy danych:
| |Header 1 |Header 2|
|------------------|---------|--------|
|**First column A**|Cell 1A |Cell 2A |
|**First column B**|Cell 1B |Cell 2B |
Przykład jest renderowany jako:
| Nagłówek 1 | Nagłówek 2 | |
|---|---|---|
| Pierwsza kolumna A | Komórka 1A | Komórka 2A |
| Pierwsza kolumna B | Komórka 1B | Komórka 2B |
Każda pozycja w pierwszej kolumnie musi być stylizowana jako pogrubiona (**bold**). W przeciwnym razie tabele nie będą dostępne dla czytników zawartości ekranu ani są prawidłowe dla platformy Microsoft Learn.
Porada
Pakiet Learn Authoring Pack dla programu VS Code zawiera funkcję umożliwiającą konwertowanie regularnej tabeli markdown na tabelę macierzy danych. Po prostu wybierz tabelę, kliknij prawym przyciskiem myszy i wybierz polecenie Konwertuj na tabelę macierzy danych.
Tabele HTML
Tabele HTML nie są zalecane w środowisku Microsoft Learn. Nie są one czytelne dla człowieka w źródle - co jest kluczową zasadą języka Markdown.