Udostępnij za pośrednictwem


Dokumentacja języka Markdown dla języka Q&A firmy Microsoft

Aplikacja Microsoft Q&A obsługuje rozbudowane środowisko edytora sieci Web, więc nigdy nie trzeba by się martwić o edytowanie zawartości w języku Markdown. W przypadku, gdy to zrobisz, jest to odwołanie do pisania języka Markdown dla pytań i pytań.

Markdown to lekki język znaczników ze składnią formatowania zwykłego tekstu. learn.microsoft.com (Learn) obsługuje elementy Markdown zgodne ze standardem CommonMark analizowane za pośrednictwem aparatu analizowania języka Markdig . Środowisko Learn i Q&A obsługuje również niestandardowe rozszerzenia języka Markdown, które zapewniają bogatszą zawartość w witrynie. Pytania i pytania używają podzbioru rozszerzeń obsługiwanych w dokumentacji środowiska Learn. Ten artykuł zawiera odwołanie alfabetyczne.

Więcej informacji można znaleźć w artykule Learn Markdown reference ( Dokumentacja języka Markdown na platformie Learn).

Fragmenty kodu

Cytat blokowy

> This example is a blockquote. It's usually rendered indented and with a different background color.

Powyższy przykład zostanie wyrenderowany następująco:

To jest cytat blokowy. Zazwyczaj jest renderowany wcięcie i ma inny kolor tła.

Bloki kodu

Język kodu można dodać do bloku kodu na potrzeby bogatszego renderowania.

```csharp
    public static void Log(string message)
            {
                _logger.LogInformation(message);
            }
    ```

Powyższy przykład zostanie wyrenderowany następująco:

    public static void Log(string message)
            {
                _logger.LogInformation(message);
            }

Emoji

Pytania i odpowiedzi przekonwertują krótki kod emoji na odpowiednie znaki Unicode:

This is a test with a :).

Powyższy przykład zostanie wyrenderowany następująco:

Jest to test z elementem 😃.

Formatowanie

Aby sformatować tekst jako pogrubiony, umieść go między podwójnymi gwiazdkami:

This text is **bold**.

Aby sformatować tekst jako kursywę, umieść go między pojedynczymi gwiazdkami:

This text is *italic*.

Aby sformatować tekst jako pogrubiony i kursywę, umieść go między potrójnymi gwiazdkami:

This text is both ***bold and italic***.

Aby sformatować tekst jako przekreślenie, ujęć go dwoma wokół niego dwoma tyldami:

This text is ~~strikeout~~.

Nagłówki

Q&A 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żde pytanie, odpowiedź lub komentarz musi mieć jeden i tylko jeden nagłówek H1.

HTML

Jeśli wprowadzisz zawartość HTML, zawartość nie będzie renderowana. Zamiast tego będzie on wyświetlany jako zwykły tekst.

Obrazy

Rozszerzenie niestandardowe :::image::: platformy Learn obsługuje standardowe obrazy, złożone obrazy i ikony.

:::image source="<folderOrURLPath>" alt-text="<alt text>":::

Gdzie <alt text> jest krótkim opisem obrazu i <folderOrURLPath> jest ścieżką względną do obrazu lub jego adresu URL. Alternatywny tekst jest wymagany na potrzeby czytników zawartości ekranu dla osób niedowidzących. Jest on również przydatny w przypadku wystąpienia usterki witryny, kiedy obraz nie może zostać wyrenderowany. Nie kopiuj nazw plików do użycia jako tekstu alternatywnego. Na przykład zamiast wartości:

:::image source="./media/bogusfilename/ADextension_2FA_Configure_Step4.PNG" alt-text="ADextension_2FA_Configure_Step4":::

Podaj wartość:

:::image source="./media/bogusfilename/ADextension_2FA_Configure_Step4.PNG" alt-text="Active Directory extension for two-factor authentication, step 4: Configure":::

Linki można łatwo dodawać w pytaniach i odpowiedziach. Łącza wskazują użytkowników na zawartość innej strony w usłudze Q&A lub innym zaufanym źródle.

[Link text](<FullURL>).
[Microsoft Q&A products page](/answers/products).`

Wyrazy uwzględnione w tekście linku powinny być przyjazne. Innymi słowy powinny one być normalnymi wyrazami lub tytułem strony, do której prowadzi link.

Nie należy używać opcji "wybierz tutaj". Nie jest ono dobre z punktu widzenia optymalizacji aparatu wyszukiwania, a ponadto nie opisuje odpowiednio miejsca docelowego.

Ważne

Wszystkie linki muszą być bezpieczne (https zamiast http), jeśli tylko element docelowy na to pozwala (a zdecydowana większość powinna).

Przykład:

For more information, see the [Microsoft Q&A products page](/answers/products).

Powyższy przykład jest renderowany jako:

Aby uzyskać więcej informacji, zobacz stronę produktów Microsoft Q&A.

Linki zostaną automatycznie sformatowane dla dowolnego ciągu rozpoczynającego się od: https://, , https://, ftp://, mailto:, tel:lub www. (rozpoznawanego jako https://www.)

Listy (numerowane, punktowane)

Lista numerowana

Aby utworzyć listę numerowaną, można użyć samych wartości 1. Liczby są renderowane w porządku rosnącym jako sekwencyjne listy podczas publikowania. Aby zwiększyć czytelność źródła, możesz ręcznie zwiększyć listę.

Nie używaj liter w przypadku list, w tym list zagnieżdżonych. Nie są one renderowane poprawnie po opublikowaniu. 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:

  1. This is
  2. lista numerowana nadrzędna
    1. and this is
    2. a parent numbered list
  3. (fin)

Lista punktowana

Aby utworzyć listę punktowaną, użyj znaku - lub *, a następnie spacji 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
  • nadrzędna lista punktowana
    • and this is
    • a nested bulleted list
  • Gotowe!

Niezależnie od używanej - składni lub *, należy używać jej spójnie w zawartości.

Tabele

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
table dane tutaj
it doesn't actually have to line up nicely!