Korzystanie z języka Markdown w usłudze Azure DevOps

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

W tym artykule opisano podstawową składnię używania formatu Markdown (md) z funkcjami usługi Azure DevOps, w tym stron typu wiki. Składnia języka Markdown umożliwia dodawanie specjalnego formatowania do zawartości strony, takich jak nagłówki, listy, tabele i obrazy. Użyj języka Markdown, aby sformatować pliki README, dashboardy, zawartość pull requestów i nie tylko.

Istnieją dwie opcje formatowania: typowe konwencje języka Markdown i rozszerzenia języka Markdown dla usługi GitHub.

Obsługa funkcji usługi Azure DevOps

Składnia języka Markdown umożliwia formatowanie zawartości za pomocą nagłówków, linków referencyjnych, pogrubionego tekstu i załączników plików. Nie wszystkie składnie języka Markdown działają z każdą funkcją w usłudze Azure DevOps. Najważniejsze funkcje, które obsługują składnię języka Markdown, obejmują:

• Kryteria definicji ukończenia (tablicy) dla kamieni milowych projektu.
• Cele i metryki zespołu za pomocą widżetu markdown.
• Żądania ściągnięcia dla plików projektu w repozytorium Git.
• Pliki README w repozytorium Git, które pomagają współpracownikom.
• Pliki wiki dotyczące zawartości stron w projektowej wiki zespołowej.

Poniższa lista zawiera elementy języka Markdown obsługiwane przez każdą funkcję oraz linki do sekcji składni w tym artykule:

Headers

Utwórz strukturę zawartości przy użyciu nagłówków języka Markdown. Nagłówki oddzielają długie fragmenty zawartości strony do sekcji, które są łatwiejsze do odczytania. Nagłówki można dodawać w definicji gotowej (tablicy), widżetuMarkdown, żądań ściągnięcia, plików Readme i plików typu wiki.

Aby zdefiniować nagłówek najwyższego poziomu, rozpocznij wiersz od pojedynczego znaku #, a następnie wprowadź tekst nagłówka, taki jak # Get started on the project. Organizuj uwagi za pomocą podtytułów, zaczynając wiersz od więcej niż jednego znaku krzyżyka, na przykład ## Request permissions lub ### Send feedback. Do tworzenia poziomów rozmiaru nagłówków można użyć maksymalnie sześciu znaków skrótu.

Przykład: tworzenie nagłówków w języku Markdown

Poniższy kod Markdown tworzy nagłówek najwyższego poziomu (H1) i cztery poziomy nagłówków podrzędnych (H2, H3, H4 i H5):

# This is a top-level (H1) header
## This is a subheader (H2)
### This is a lower subheader (H3)
#### This is an H4 header
##### This is an H5 header

Na poniższej ilustracji przedstawiono opublikowany widok języka Markdown:

Akapity i łamanie wierszy

Podziel długie sekcje na mniejsze akapity lub wstaw podziały wierszy, aby ułatwić odczytywanie tekstu.

Dodaj akapity i podziały wierszy w Definition of Done (tablica), widżecie Markdown, pull requestach, plikach Readme i plikach wiki.

Przykład: Dodawać podziały w znacznikach Markdown i żądaniach dołączenia

Komentarze w żądaniu ściągnięcia akceptują znaczniki Markdown, takie jak styl pogrubienia i kursywa tekstu. Użyj Enter, aby wstawić podział wiersza i rozpocząć nowy tekst w następnym wierszu lub dodać odstępy między wierszami.

Aby utworzyć podział wiersza w akapicie w usłudze Azure DevOps, dodaj dwa spacje na końcu wiersza przed naciśnięciem Enter:

This is the first line with two spaces at the end.  
This is the second line, which will appear directly below the first.

Zostanie wyrenderowane jako:

Jest to pierwszy wiersz z dwoma spacjami na końcu.
Jest to drugi wiersz, który pojawi się bezpośrednio poniżej pierwszego.

W przypadku naciśnięcia Enter bez dwóch spacji końcowych wiersze łączą się w pojedynczy akapit w opublikowanych danych wyjściowych.

Aby utworzyć nowy akapit (z pustym wierszem między), naciśnij Enter dwa razy:

This is the first paragraph.

This is the second paragraph.

Na poniższej ilustracji przedstawiono opublikowany widok Markdown dotyczącego odstępów w komentarzu pull request:

Przykład: Dodawanie podziałów w plikach Markdown lub widżetach

W pliku Markdown lub widżecie markdown rozdziel wiersze tekstu, aby utworzyć nowe akapity. Dodaj dwie spacje (Space) przed podziałem wiersza i naciśnij Enter, aby rozpocząć nowy akapit.

Add two **Space** characters before the end of the line and then press **Enter**.
The next paragraph starts on a new line. The two paragraphs are separated by a blank line.

Na poniższej ilustracji przedstawiono opublikowany widok języka Markdown dla odstępów w widżecie:

Cytaty blokowe

Zacytuj komentarze lub tekst, aby ustawić kontekst nowego komentarza lub tekstu. Tekst cytowany jest wyświetlany z wcięciem z lewego marginesu i z pionową linią wzdłuż cytowanej sekcji.

Można dodawać cytaty blokowe w tablicy Definition of Done, widżecie Markdown, pull requestach, plikach Readme i plikach wiki.

Aby zacytować pojedynczy wiersz tekstu lub blok akapitu, wstaw prawy nawias > kątowy przed pierwszym tekstem.

Aby utworzyć zagnieżdżony cytat, umieść dwa lub więcej nawiasów przed tekstem. Zagnieżdżony cudzysłów jest wcięty dalej od lewego marginesu z podwójnymi liniami pionowymi wzdłuż cytowanego fragmentu.

Przykład: Zacytuj tekst, używając nawiasów kwadratowych

> Insert a bracket ">" before the text to quote the line of text.

This text references the quoted sentence.

> To quote a paragraph, insert a bracket ">" before the first text. The other lines in the paragraph are also included in the block quote. Notice the entire paragraph is indented from the left margin and highlighted with a vertical line.

This text references the quoted paragraph.

>> Insert two or more brackets ">>" before the text to create a nested quote.

>>> Nested quotes can also be multiple lines of text. Notice the nested quote text is indented further from the left margin and a vertical line is drawn for each level of bracket you insert.

This text references the nested block quotes.

Na poniższej ilustracji przedstawiono opublikowany widok języka Markdown dla cytowanego tekstu:

Reguły poziome

Podkreśl lub rozdziel sekcje zawartości i strony z regułami poziomymi. Separatory można dodawać w tablicy Definition of Done, widżecie Markdown, żądaniach ściągnięcia, plikach readme i plikach wiki.

Aby dodać regułę poziomą, wprowadź pusty wiersz, a następnie inny wiersz z trzema łącznikami (kreskami) ---.

Przykład: Wstawianie separatorów poziomych

Poniższy kod Markdown tworzy dwie reguły poziome:

Text **above** a horizontal rule
<!-- Blank -->
---
Text **between** horizontal rules
<!-- Blank -->
---
Text **under** a horizontal rule

Na poniższej ilustracji przedstawiono opublikowany widok języka Markdown dla reguł poziomych.

Wyróżnienie (pogrubienie, kursywa, przekreślenie)

Markdown umożliwia wyróżnienie tekstu na kilka sposobów.

Połącz te style, aby dodać podkreślenie. Możesz użyć stylów wyróżnienia w definicji gotowej (tablicy), widżetuMarkdown, żądań ściągnięcia, plików Readme i plików typu wiki.

Przykład: wyróżnianie tekstu

Oto kilka znaczników Markdown, które pokazują, jak wyróżniać tekst za pomocą różnych i połączonych stylów:

**Italics** highlights text in a larger block like _new terminology_.

**Bold** (strong) adds presence to text, such as **Important!**

**Strikethrough** is useful for corrections like "Send feedback ~~to the team~~."

Combine styles for other effects, such as ~~__Content removed__~~ and **_Milestones_**.

Na następnym obrazie pokazano, jak style podkreślenia tekstu Markdown wyglądają po opublikowaniu.

Wyróżnianie kodu

Wyróżnij bloki tekstu lub tekst wbudowany jako kod za pomocą podświetlenia kodu. Wyróżnianie kodu można dodawać w pull requestach, plikach Readme i plikach wiki.

Aby sformatować blok tekstowy jako kod, należy ująć blok w trzy znaki backtick (```). Backticks, które rozpoczynają i kończą sekcję, muszą znajdować się w osobnym wierszu od bloku kodu, aby wyróżnić.

Można również sformatować część tekstu w większym bloku tekstowym jako wbudowany segment kodu. W tym stylu należy ująć kod liniowy w pojedyncze apostrofy zwrotne. Backticks są w tej samej linii z tekstem, a nie w oddzielnych wierszach.

Wyróżnianie kodu w widżecie Markdown przedstawia kod jako zwykły tekst sformatowany wstępnie.

Przykład: wyróżnianie bloku kodu w widżecie języka Markdown

W tym przykładzie pokazano, jak wyróżnić blok tekstowy jako kod w widżecie Markdown:

<!-- ```  Three backticks to start block " -->
sudo npm install vsoagent-installer -g
<!-- ```  Three backticks to end block -->

W tym przykładzie pokazano opublikowany widok języka Markdown dla bloku tekstowego wyróżnionego jako kod:

sudo npm install vsoagent-installer -g

Przykład: wyróżnianie kodu inline w widżecie Markdown

W tym przykładzie pokazano, jak wyróżnić część tekstu jako wbudowany segment kodu w widżecie markdown:

To install the Microsoft Cross Platform Build and Release Agent, run the following: <!-- ` - Single backtick --> $ sudo npm install vsoagent-installer -g <!-- ` - Single backtick -->

Ten obraz przedstawia opublikowany widok języka Markdown dla części tekstu wyróżnionej jako wbudowany segment kodu:

Przykład: konwertowanie tekstu na kod, identyfikowanie języka kodu

Istnieje inny sposób konwertowania bloku tekstowego na kod. Gdy wiersz tekstu w języku Markdown zaczyna się od czterech spacji na lewym marginesie, tekst jest automatycznie konwertowany na blok kodu. W tym przykładzie pokazano to zachowanie:

    This article is a Markdown file (_.md_). This line of text automatically formats as code because the line starts with four spaces in the left margin.

Preferowaną metodą jest ujęcie tekstu w trzy backticks, aby można było określić identyfikator języka. Identyfikator stosuje wyróżnianie składni do kodu zgodnie z konwencjami określonego języka. Etykiety identyfikatorów są dostępne dla większości języków programowania, takich jak JavaScript (js), C# (csharp) i Markdown (md). Listę obsługiwanych języków można znaleźć w repozytorium GitHub highlightjs .

W tych przykładach pokazano, jak zidentyfikować blok tekstu jako javaScript lub C#. Dodaj etykietę identyfikatora języka po trzech pierwszych backticksach, tak jak w pliku ```md.

JavaScript

<!-- ```js       - Three backticks and identifier 'js' -->
const count = records.length;
<!-- ```         - Three backticks -->

Jest to opublikowany widok kodu JavaScript:

const count = records.length;

C#

<!-- ```csharp   - Three backticks and identifier 'csharp' -->
Console.WriteLine("Hello, World!");
<!-- ```         - Three backticks -->

Jest to opublikowany widok kodu C#:

Console.WriteLine("Hello, World!");

Sugerowanie zmiany

Żądania pull requesty w GitHub obsługują funkcję Komentarz, która umożliwia współtwórcom dostarczanie danych wejściowych i sugerowanie zmian. Dodaj komentarz dla określonego wiersza lub wielu wierszy w pliku. Autor pull requestu stosuje sugerowaną zmianę w komentarzu, wybierając pozycję Zastosuj zmianę. Ta akcja zatwierdza zmianę żądania ściągnięcia i uruchamia kompilację.

Po dodaniu komentarza zawierającego wyróżnianie kodu w widżecie markdown kod jest wyświetlany w formacie różnic. Zmiany w zmodyfikowanym wierszu są oznaczone adnotacjami, aby pokazać różnice. Symbol - minus wskazuje usuniętą zawartość, a symbol + plus wyróżnia nową zawartość.

Przykład: Zasugeruj zmiany w komentarzu do pull requestu

W tym przykładzie pokazano, jak sugerować zmiany w kodzie w pull request w widżecie Markdown. W tym scenariuszu blok kodu używa identyfikatora suggestion:

<!-- ```suggestion   - Three backticks and identifier 'suggestion' -->
  for i in range(A, B+100, C):
<!-- ```         - Three backticks -->

Na poniższej ilustracji przedstawiono widok różnic z sugestią komentarza.

Aby uzyskać więcej informacji, przejdź do Sugerowanie zmian w komentarzach.

Tables

Organizowanie danych ustrukturyzowanych przy użyciu tabel języka Markdown. Dodaj tabele w widżecie Markdown, żądaniach ściągnięcia, plikach Readme i plikach typu wiki. Tabele są szczególnie przydatne do opisywania parametrów funkcji, metod obiektów i innych danych z wyraźnym mapowaniem nazwy do opisu.

Oto kilka kwestii dotyczących pracy z tabelami w języku Markdown:

• Utwórz każdą linię osobno i zakończ każdą linię znakiem powrotu karetki (CR) lub znakiem zakończenia linii (LF).
• Utwórz kolumny z kreskami - i symbolem pionowej kreski |, na przykład |---|---|---|.
• Zdefiniuj nagłówki kolumn w pierwszym wierszu, na przykład | First | Middle | Last |.
• Ustaw wyrównanie kolumny (w lewo, w środku, w prawo) przy użyciu dwukropków : w drugim wierszu, na przykład |:--|:--:|--:|.
• Uniknij symbolu pionowej kreski ukośnikiem \|, gdy używasz go w tekście tabeli, na przykład | Describe the pipe \| symbol. |.
• Dodaj podziały wierszy w komórce, używając tagu HTML <br/>. Takie podejście działa w witrynie typu wiki, ale nie gdzie indziej.
• Dodaj puste miejsce przed elementem roboczym lub żądaniem ściągnięcia wymienionym w tekście tabeli.

Przykład: tworzenie tabeli

W poniższym przykładzie pokazano, jak utworzyć tabelę z trzema kolumnami i pięcioma wierszami w języku Markdown:

| Feature | Prerelease | Release target |  
|:---|:---:|---:|
| Calculator | No | 10/27/2025 |
| Graphs | Yes | 8/18/2025 |
| Mail | No | 2/16/2025 |
| Tables | Yes | 10/27/2025 |
| Search | No | 1/5/2026 |

Oto jak tabela Markdown wygląda po opublikowaniu:

Lists

Organizowanie powiązanych elementów przy użyciu różnych typów list. Użyj listy uporządkowanej, aby wyświetlić kolejność lub sekwencję elementów. Użyj punktorów dla powiązanych elementów, które nie muszą być w kolejności. Dodaj style listy w Definicji ukończenia (tablicy), w widżecie Markdown, żądaniach pull, plikach Readme i plikach wiki.

Oto kilka kwestii dotyczących pracy z listami w języku Markdown:

• Określ każdy element listy w osobnym wierszu.
• Rozpocznij każdy element na uporządkowanej liście z liczbą, po której następuje kropka, na przykład 1. First item 1. Next item. system publikowania automatycznie numeruje listę.
• Uruchom każdy element na liście nieuporządkowanej za pomocą łącznika - lub gwiazdki *, na przykład - First point - Next point.
• Sprawdź odstępy przed listami i po nim w pliku markdown lub widżecie:
  • Dla pierwszej listy dodaj pusty wiersz przed i po liście.
  • W przypadku list wielopoziomowych użyj poprawnego wcięcia. Nie potrzebujesz dodatkowych podziałów wierszy przed ani po zagnieżdżonych listach.

Przykład: tworzenie listy numerowanej (uporządkowanej)

W tym przykładzie pokazano, jak utworzyć listę numerowaną dla elementów w sekwencji przy użyciu języka Markdown:

<!-- Blank -->
1. First step in the procedure.
1. Second step.
1. Third step.
<!-- Blank -->

Oto widok opublikowanej wersji listy uporządkowanej w języku Markdown:

1. Pierwszy krok procedury.
2. Drugi krok.
3. Trzeci krok.

Przykład: Tworzenie listy wypunktowanej (nieuporządkowanej)

W tym przykładzie pokazano, jak utworzyć nieurządkowaną listę powiązanych elementów przy użyciu języka Markdown:

<!-- Blank -->
- First item in the list.
- Next item.
- Last item.
<!-- Blank -->

Oto opublikowany widok listy nieuporządkowanej w Markdown:

• Pierwszy element na liście.
• Następny element.
• Ostatni element.

Przykład: listy zagnieżdżone

Twórz listy na listach i mieszaj style.

W tym przykładzie pokazano, jak utworzyć listę numerowaną z zagnieżdżonych list wypunktowanych w języku Markdown.

<!-- Blank -->
1. First step in the procedure.
   - First item in a nested list.
   - Next item.
   - Last item.
1. Second step.
   - First item in a nested list.
      - First item in a subnested list.
      - Next item.
   - Last item.
1. Third step.
   1. First substep.
   1. Next substep.
   1. Last substep.
<!-- Blank -->

To opublikowany widok listy z zagnieżdżonymi listami.

1. Pierwszy krok procedury.
   • Pierwszy element na zagnieżdżonej liście.
   • Następny element.
   • Ostatni element.
2. Drugi krok.
   • Pierwszy element na zagnieżdżonej liście.
     • Pierwszy element na liście podrzędnej.
     • Następny element.
   • Ostatni element.
3. Trzeci krok.
   1. Pierwszy podkrok.
   2. Następny podkrok.
   3. Ostatni podkrok.

Links

Połącz z elementami roboczymi, wprowadzając hash # i identyfikator elementu roboczego, a następnie wybierz element roboczy z listy. Dodaj różne typy łączy w Definicji Gotowości (tablica), widżetu Markdown, prośbach o ściągnięcie, plikach Readme i plikach typu wiki.

Oto kilka kwestii dotyczących pracy z linkami w języku Markdown:

• Standardowa składnia języka Markdown dla linku to [Link display text](Link path).

• W komentarzach w żądaniach łączenia i na witrynach typu wiki adresy URL rozpoczynające się od HTTP lub HTTPS są automatycznie formatowane jako linki.

• Jeśli używasz znaku hash # na inne sposoby, na przykład kody szesnastkowe kolorów, możesz uniknąć automatycznych sugestii dotyczących elementów roboczych, dodając przed znakiem hash # znak backslash \.

• W plikach i widżetach języka Markdown utwórz hiperlinki tekstowe dla adresu URL przy użyciu standardowej składni linku języka Markdown. Wartość Link path może być względna lub bezwzględna.

  W poniższym przykładzie pokazano, jak określić względny link w języku Markdown. Tekst jest renderowany jako hiperlink:

  For more information, see the [C# language reference](/dotnet/csharp/language-reference/).
  

  Oto opublikowany widok linku:

  Aby uzyskać więcej informacji, zobacz dokumentację języka C#.

Obsługiwane linki

Gdy łączysz się z inną stroną Markdown w tym samym repozytorium Git lub Team Foundation Version Control (TFVC), określ cel linku jako ścieżkę względną lub bezwzględną.

W poniższych sekcjach przedstawiono przykłady różnych scenariuszy języka Markdown.

Przykład: linki względne strony powitalnej

Oto kilka przykładów linków względnych na stronie powitalnej strony typu wiki:

• Ścieżka względna: [Display text](target.md)

• Ścieżka bezwzględna w Git: [Display text](/folder/target.md)

• Ścieżka bezwzględna w programie TFVC: [Display text]($/project/folder/target.md)

• Adres URL: [Display text](http://address.com)

Przykład: linki względne widżetu Markdown

W poniższym przykładzie pokazano link względny w widżecie Markdown:

• Adres URL: [Display text](http://address.com)

Przykład: linki względne stron typu wiki

Oto kilka przykładów linków względnych na stronie typu wiki:

• Bezwzględna ścieżka stron typu wiki: [Display text](/parent-page/child-page)
• Adres URL: [Display text](http://address.com)

Łącza względne kontroli źródła

Względne linki do plików kontroli źródła są interpretowane inaczej na stronie powitalnej i widżecie języka Markdown:

Przykład: linki względne strony powitalnej

Linki względne na stronie powitalnej odnoszą się do katalogu głównego repozytorium kontroli wersji, w którym znajduje się strona powitalna. Oto kilka przykładów:

• /BuildTemplates/AzureContinuousDeploy.11.xaml
• ./page-2.md

Przykład: linki względne widżetu Markdown

Względne linki w widżecie markdown są względne względem bazy adresów URL kolekcji projektów zespołowych. Oto kilka przykładów:

• /DefaultCollection/Fabrikam/versionControl#path=$/TFVC-Welcome/BuildTemplates/AzureContinuousDeploy.11.xaml
• /DefaultCollection/Fabrikam/versionControl#path=$/TFVC-Welcome/page-2.md

Łącza zakotwiczenia

Gdy plik Markdown jest renderowany jako HTML, system przypisuje identyfikator kotwicy do każdego nagłówka na stronie. Identyfikator jest przekonwertowaną formą tekstu nagłówka. System stosuje następujące zmiany w celu utworzenia identyfikatora:

• Zamienianie spacji w tekście nagłówka łącznikami -
• Zmień wielkie litery na małe litery
• Konwertowanie większości znaków specjalnych i znaków interpunkcyjnych na łączniki, w tym :, , "?, @, , $#
• Usuń lub skonwertuj inne znaki specjalne zgodnie z regułami silnika renderującego

Użyj znacznika hash #, aby utworzyć link do nagłówka w dokumencie, tak jak w [Display text](#<header-anchor>).

W poniższym przykładzie przedstawiono nagłówek i link do jego identyfikatora kotwicy.

#### Team #1 : Release Wiki!

Welcome to the Release wiki. For more information, [Visit the Project Wiki](#team-1--release-wiki).

Oto opublikowany widok:

Team #1: Release Wiki!

Witamy w wiki wydania. Aby uzyskać więcej informacji, odwiedź witrynę typu wiki projektu.

Połącz z nagłówkiem w innym pliku Markdown, określając nazwę pliku z ID zakotwiczenia w linku:

[Set up a project wiki](about-readme-wiki.md#set-up-a-project-wiki).

Strona typu wiki jest również plikiem markdown. Odwołuj się do nagłówka na jednej stronie w witrynie typu wiki z innej strony:

Welcome to the Wiki!

- [Get Started](/get-started-page)
- [Contribute content](/get-started-page#contribute)
- [Send Feedback](/contact-page#send-feedback)

Images

Użyj obrazów i animowanych plików GIF, aby zademonstrować koncepcje i dodać zainteresowanie wizualne do zawartości. Dodaj obrazy w widżecie Markdown, żądaniach ściągnięcia, plikach Readme i plikach typu wiki.

Użyj standardowej składni języka Markdown dla obrazu lub animowanego pliku GIF: ![Image alt text](Image path). Ta składnia jest podobna do łącza, ale wiersz zaczyna się od symbolu wykrzyknika ! .

Image alt text Opisuje obraz i jest wyświetlany po umieszczeniu wskaźnika myszy użytkownika na obrazie w opublikowanym widoku. Image path identyfikuje lokalizację obrazu.

Oto przykład, który dodaje ilustrację do pliku Markdown:

![Illustration to use for new users](https://azurecomcdn.azureedge.net/cvt-779fa2985e70b1ef1c34d319b505f7b4417add09948df4c5b81db2a9bad966e5/images/page/services/devops/hero-images/index-hero.jpg)

Ścieżka obrazu

Ścieżka do pliku obrazu może być ścieżką względną lub ścieżką bezwzględną w usłudze Git lub TFVC, podobnie jak ścieżka do innego pliku Markdown w linku.

• Ścieżka względna: ![Image alt text](./image.png)
• Ścieżka bezwzględna w Git: ![Image alt text](/media/markdown-guidance/image.png)
• Ścieżka bezwzględna w programie TFVC: ![Image alt text]($/project/folder/media/markdown-guidance/image.png)

Rozmiar obrazu

Ustaw rozmiar obrazu przy użyciu Image-path =Image-widthxImage-height składni:

• Litera x reprezentuje wartość "by" w wyrażeniu width-by-height.
• Nie dodawaj spacji przed literą ani po nim x.
• Dołącz spację przed znakiem równości = .
• Aby określić tylko szerokość, użyj polecenia Image-path =Image-widthx. Nadal musisz dołączyć literę x.

Oto przykład składni języka Markdown dla obrazu o szerokości 500 i wysokości 250:

![Image alt text](./image.png =500x250)

Lista kontrolna lub lista zadań

Śledź postęp swoich zadań i czynności przy użyciu uproszczonych list zadań. Dodaj listy kontrolne lub listy zadań w żądaniach ściągnięcia i plikach typu wiki. Ta funkcja jest przydatna w opisie żądania ściągnięcia w celu śledzenia danych wejściowych od recenzentów lub na stronie projektu typu wiki w celu śledzenia stanu zadania.

Przykład: Tworzenie listy kontrolnej w języku Markdown

Utwórz listę kontrolną bezpośrednio w języku Markdown:

• Użyj pustych nawiasów kwadratowych [<space>] , aby utworzyć nowe zadanie.
• Pokaż zadanie jako ukończone, dołączając literę x wewnątrz nawiasów kwadratowych [x].
• Poprzedzaj każde zadanie łącznikiem i spacją -<space>[<space>] lub liczbą i spacją 1.<space>[<space>]. Użyj dowolnej liczby.
• Nie używaj listy kontrolnej wewnątrz tabeli języka Markdown.

Poniższy przykład tworzy listę kontrolną z czterema elementami, gdzie pierwszy element jest oznaczony jako ukończony:

- [x] Project plan
- [ ] Draft 1 code
- [ ] Draft 2 code
- [ ] Test plan

Oto opublikowany widok listy kontrolnej:

Po opublikowaniu listy kontrolnej użytkownicy oznaczą element jako ukończony, zaznaczając pole wyboru elementu na liście.

Przykład: Zastosuj składnię Markdown listy zadań do zaznaczonego tekstu

Wybierz istniejący tekst w portalu internetowym i użyj akcji na pasku narzędzi Markdown, aby zastosować format listy kontrolnej. Po dodaniu listy kontrolnej lub zadania w ten sposób edytuj listę lub zadanie w języku Markdown.

Na poniższym obrazku pokazano, jak zastosować styl listy zadań na pasku narzędzi Markdown do wybranego tekstu:

Oznacz zadanie jako ukończone, zaznaczając pole zadania na liście:

Reakcje emoji

Dodaj reakcje emoji w pull requestach i plikach wiki. Użyj reakcji emoji, aby dodać charakter i reagować na komentarze w ramach zgłoszenia.

Wprowadź nazwę emocji lub wyrażenia, na przykład smile i ujęć tekst w znaki dwukropka : . W opublikowanym widoku języka Markdown dane wejściowe są konwertowane na odpowiednią grafikę emoji. Język Markdown w usłudze Azure DevOps obsługuje większość grafiki emoji usługi GitHub. Nie obsługuje niestandardowego emoji , takiego jak :bowtie:.

Przykład: dodawanie reakcji emoji w żądaniu ściągnięcia

W tym przykładzie pokazano, jak dodać reakcje emoji za pomocą języka Markdown w komentarzu żądania ściągnięcia:

The code review received :+1::+1: and the team is :smile:

Na tym obrazie przedstawiono opublikowany widok reakcji emoji:

Przykład: ucieczka składni emoji w języku Markdown

W tym przykładzie pokazano, jak uniknąć składni emoji za pomocą znaku ukośnika odwrotnego \ w Markdown.

Markdown syntax for some emoji reactions:
- **Happy** \:smile:
- **Angry** \:angry:
- **Sad** \:cry:

Na tej ilustracji przedstawiono opublikowany widok języka Markdown przedstawiający składnię emoji:

W komentarzu pull request użyj dwóch ukośników odwrotnych \\, aby uniknąć konwersji składni emoji.

Znaki specjalne jako tekst w formie dosłownej

Użyj ukośnika \ odwrotnego jako znaku ucieczki w języku Markdown, aby opublikować znaki specjalne jako dosłowny tekst. Ukośnik odwrotny informuje system publikowania, aby pokazywał znak specjalny jako tekst jawny i go nie interpretował ani nie konwertował.

Użyj składni ignorowania i ucieczki w Definicja zakończenia (tablica), widżet Markdown, żądania zmiany, pliki Readme i pliki wiki.

Przykład: Publikowanie znaków specjalnych

Składnia języka Markdown "Tekst umieszczony w apostrofach" jest wyświetlany jako Enclose text in backticks w opublikowanym widoku. System publikowania stosuje inline code format do tekstu w backticks (') i nie publikuje backticksów.

Jeśli poprzedzisz backtick (`) ukośnikiem odwrotnym (\), format tekstu wewnątrz backticków nie ulegnie zmianie, a backticki zostaną opublikowane. To zachowanie działa w przypadku większości znaków specjalnych, w tym nawiasów (), nawiasów kwadratowych [], podkreślenia _, łącznika -, znaku krzyżyka #, gwiazdki *, odwrotnego apostrofu ` oraz samego ukośnika \.

Poniższy kod Markdown używa znaku ukośnika odwrotnego \ do przedstawiania znaków specjalnych jako tekstu literału.

\\\ Code comment

Show the **\_\_**underscores**\_\_**

\# Code comment and not a **Heading** 

**\(** Include the **parentheses \)**

Show the __\*__asterisks__\*__ and don't change to *italics*

Oto opublikowany widok języka Markdown:

\\ Komentarz kodu

Pokaż znaki __underscores__

# Komentarz kodu, a nie nagłówek

( Dołącz nawiasy )

* Pokaż gwiazdki* i nie zmieniaj na kursywę

Attachments

Dołączanie plików w komentarzach żądania ściągnięcia i stronach typu wiki. Załączniki mogą pomóc zilustrować punkt lub podać szczegółowe informacje o sugestiach. Załączniki obsługują następujące formaty plików:

Dołączanie obrazów lub plików

Obraz lub plik można dołączyć w polu Komentarz żądania ściągnięcia lub na stronie typu wiki w okienku Edycja na kilka sposobów:

• Przeciągnij plik do komentarza lub na stronę typu wiki.

• Wklej obraz ze schowka do komentarza lub na stronę wiki. Obraz jest wyświetlany bezpośrednio w komentarzu lub na stronie typu wiki.

• Wybierz ikonę Dołącz (papierklip) w komentarzu lub w okienku Format na stronie typu wiki, a następnie wybierz plik do dołączenia:

  

Po dołączeniu pliku innego niż obraz, system tworzy link do pliku w komentarzu lub na stronie wiki. Zmień tekst wyświetlania linku w nawiasach kwadratowych, tak jak w pliku [Updated link display text](LINK URL). Po opublikowaniu strony lub komentarza użytkownik wybierze link, aby uzyskać dostęp do załącznika.

Notacja matematyczna i znaki

Możesz użyć notacji matematycznej i znaków w komentarzach żądania ściągnięcia i plikach typu wiki. Obsługiwane są zarówno wbudowane, jak i blokowe notacje KaTeX , które obejmują następujące elementy:

• Symbols
• Litery greckie
• Operatory matematyczne
• Uprawnienia i indeksy
• Ułamki i dwumiany
• Inne elementy obsługiwane przez platformę KaTeX

W pliku Markdown notacja matematyczna jest ujęta w znaki dolara $. Aby utworzyć wyrażenie wbudowane z innym tekstem, należy ująć notację z pojedynczymi znakami dolara, $ A + B = C $. W przypadku wyrażenia bloku rozpocznij i zakończ blok z dwoma znakami dolara: $$ A = 1 \ B = 2 \ C = A + B $$.

Przykład: Wyświetlanie listy znaków greckich

W poniższym przykładzie wymieniono greckie znaki używane w notacji matematycznej przez dodanie fragmentu kodu w pliku Markdown. Zwróć uwagę, że identyfikator języka fragmentu kodu to KaTeX , a nie Markdown md:

$
\alpha, \beta, \gamma, \delta, \epsilon, \zeta, \eta, \theta, \kappa, \lambda, \mu, \nu, \omicron, \pi, \rho, \sigma, \tau, \upsilon, \phi, ...
$  

$\Gamma,  \Delta,  \Theta, \Lambda, \Xi, \Pi, \Sigma, \Upsilon, \Phi, \Psi, \Omega$

Oto opublikowany widok greckich znaków:

Przykład: Użyj notacji algebraicznej

W poniższym przykładzie użyto notacji wbudowanej i algebraicznego wyrażenia blokowego.

Area of a circle is $\pi r^2$

And, the area of a triangle is:

$$
A_{triangle}=\frac{1}{2}({b}\cdot{h})
$$

Oto opublikowany widok notacji w pliku Markdown:

Przykład: Pokazywanie sum i całkowitoliczników

W poniższym przykładzie użyto dwóch wyrażeń blokowych do obliczania sum i całkowitoliczników:

$$
\sum_{i=1}^{10} t_i
$$

$$
\int_0^\infty \mathrm{e}^{-x}\,\mathrm{d}x
$$     

Oto opublikowany widok wyrażeń w pliku Markdown:

Markdown w wiki Azure DevOps

Istnieje wiele sposobów używania języka Markdown, aby ulepszyć witrynę typu wiki usługi Azure DevOps. W poniższych sekcjach przedstawiono przykłady składni dla różnych zadań:

• Dodawanie diagramów Mermaid, takich jak diagramy sekwencji, schematy blokowe i ścieżki użytkowników
• Tworzenie spisu treści dla stron i podstron
• Konfigurowanie zwijanych sekcji stron
• Osadzanie klipów wideo i wyników zapytań usługi Azure Boards
• Link do elementów roboczych z hashtagiem #
• Używanie @<alias> wzmianek dla użytkowników i grup
• Uwzględnij elementy HTML, takie jak <font> dla tekstu sformatowanego
• Sprawdzanie liczby wizyt strony

Dostępność tych funkcji zależy od używanej wersji usługi Azure DevOps.

::: mermaid
<diagram type>
   <diagam information>
:::

::: mermaid
sequenceDiagram
    Christie->>Josh: Hello Josh, how are you?
    Josh-->>Christie: Great!
    Christie->>Josh: See you later!
:::

::: mermaid
gantt
    title A Gantt chart
    dateFormat YYYY-MM-DD
    excludes 2022-03-16,2022-03-18,2022-03-19
    section Section

    A task          :a1, 2022-03-07, 7d
    Another task    :after a1 , 5d
:::

:::mermaid
graph LR;
    A[Hard edge] -->|Link text| B(Round edge) --> C{Decision}
    C -->|One| D[Result one]
    C -->|Two| E[Result two]
:::

:::mermaid
classDiagram
    Creature <|-- Superman
    Creature <|-- Vampire
    Creature <|-- Diavolo
    Creature: +int size
    Creature: +int weight
    Creature: +isBenign()
    Creature: +power()
    class Superman{
        +String currentName
        +fly()
        +heal()
    }
    class Vampire{
        -int age
        -canBite()
    }
    class Diavolo{
        +bool is_serving
        +heat()
    }
:::

:::mermaid
stateDiagram-v2
    [*] --> Active
    state Active {
        [*] --> NumLockOff
        NumLockOff --> NumLockOn : EvNumLockPressed
        NumLockOn --> NumLockOff : EvNumLockPressed
        --
        [*] --> CapsLockOff
        CapsLockOff --> CapsLockOn : EvCapsLockPressed
        CapsLockOn --> CapsLockOff : EvCapsLockPressed
        --
        [*] --> ScrollLockOff
        ScrollLockOff --> ScrollLockOn : EvScrollLockPressed
        ScrollLockOn --> ScrollLockOff : EvScrollLockPressed
    }
:::

:::mermaid
journey
    title Home office day
    section Go to work
      Wake up: 1: Me, Dog
      Take shower: 2: Me
      Go downstairs: 3: Me, Dog
      Make coffee: 4: Me
      Have a breakfast: 5: Me, Dog
      Go upstairs: 3: Me, Dog
      Do work: 1: Me, Dog
    section Go home
      Go downstairs: 3: Me, Dog
      Sit down: 5: Me
:::

:::mermaid
pie title Fishermen in countries
    "Norway" : 684
    "Sweeden" : 234
    "Switzerland" : 10
:::

:::mermaid
requirementDiagram
    requirement development_req {
    id: 1
    text: requirements spec.
    risk: medium
    verifymethod: test
    }
    element test_suite {
    type: manual test
    }
    test_suite - verifies -> development_req
:::

::: mermaid
gitGraph
  commit id: "Initial commit"
  branch develop
  commit id: "Develop commit 1"
  commit id: "Develop commit 2"
  checkout main
  commit id: "Main commit 1"
  merge develop id: "Merge develop into main"
  branch feature
  checkout feature
  commit id: "Feature commit 1"
  checkout develop
  commit id: "Develop commit 3"
  checkout feature
  merge develop id: "Merge develop into feature"
:::

::: mermaid
erDiagram
  CUSTOMER {
    string name
    string address
  }
  ORDER {
    int orderNumber
    string product
  }
  CUSTOMER ||--o{ ORDER : places
:::

::: mermaid
timeline
  title Project Development Timeline
  section Planning
    Project kickoff : 2025-01-01
    Requirements gathering : 2025-01-15
  section Development
    Initial development : 2025-02-01
    First prototype : 2025-03-01
  section Testing
    Alpha testing : 2025-04-01
    Beta testing : 2025-05-01
  section Release
    Public release : 2025-06-01
:::

# A collapsible section with Markdown syntax
<details>
  <summary>Click to expand!</summary>

  ## Heading
  1. A numbered
  2. list
     * With some
     * Sub bullets
</details>

Watch the following video:

::: video
<iframe width="640" height="360" src="https://www.youtube.com/embed/OtqFyBA6Dbk" allowfullscreen style="border:none"></iframe>
:::

Results from the Azure Boards query:

:::
query-table 6ff7777e-8ca5-4f04-a7f6-9e63737dddf7
:::

Tagi HTML na stronach typu wiki

Utwórz bogatą zawartość przy użyciu tagów HTML na stronach typu wiki, takich jak <font> i <span>. W usłudze Azure DevOps Server 2019.1 lub nowszym możesz również wkleić bogatą zawartość, na przykład obrazy i wideo jako kod HTML.

Przykład: używanie składni języka Markdown wewnątrz kodu HTML

W poniższym przykładzie pokazano, jak używać składni języka Markdown wewnątrz elementu HTML na stronie typu wiki. Dodaj pusty wiersz po otwarciu elementu HTML i przed kodem Markdown:

<p>

This article describes how to **get started** with an Azure DevOps wiki.

For more information, see the [Wikis, search, & navigation documentation](https://learn.microsoft.com/azure/devops/project/) for Azure DevOps.
</p>

Przykład: osadzanie klipu wideo za pomocą kodu HTML

W poniższym przykładzie pokazano, jak osadzić film wideo na stronie typu wiki przy użyciu <video> elementu HTML z adresem URL do wideo:

<video src="https://sec.ch9.ms/ch9/7247/7c8ddc1a-348b-4ba9-ab61-51fded6e7247/vstswiki_high.mp4" width=400 controls>
</video>

Przykład: użyj formatu RTF

W poniższym przykładzie pokazano, jak używać formatu tekstu sformatowanego HTML na stronie typu wiki:

<p>This text needs to <del>strikethrough</del> <ins>since it is redundant</ins>!</p>
<p><tt>This text is teletype text.</tt></p>
<font color="blue">Colored text</font>
<center>This text is center-aligned.</center>
<p>This text contains <sup>superscript</sup> text.</p>
<p>This text contains <sub>subscript</sub> text.</p>
<p>The project status is <span style="color:green;font-weight:bold">GREEN</span> even though the bug count / developer might be shown as <span style="color:red;font-weight:bold">red.</span> - Capability of span
<p><small>Disclaimer: Wiki also supports showing small text</small></p>
<p><big>Bigger text</big></p>

Na poniższej ilustracji przedstawiono opublikowany widok zawartości tekstu sformatowanego HTML na stronie typu wiki, jak pokazano w standardowym widoku motywu Light:

Oto ta sama opublikowana strona w widoku motywu ciemnego:

Treści powiązane

• strona projektu lub strony powitalne
• Katalog widżetów
• dodawanie i edytowanie stron typu wiki