Jaa

Microsoftin Q&A-Markdown-viiteopas

  • Artikkeli

Microsoft Q&A tukee monipuolisen verkkoeditorin käyttökokemusta, joten sinun ei tarvitse huolehtia sisällön muokkaamisesta Markdownissa. Jos teet näin, tässä on viittaus Markdownin kirjoittamiseen Q&A:lle.

Markdown on kevyt merkintäkieli, jonka syntaksi on tekstipohjainen. learn.microsoft.com(Learn) tukee CommonMark-yhteensopivaa Markdown-syntaksia Markdig-jäsennyksellä. Learn ja Q&A tukevat myös mukautettuja Markdown-laajennuksia, jotka tarjoavat sivustolla monipuolisempaa sisältöä. Q&A käyttää learnin dokumentaatiossa tuettujen laajennusten alijoukkoa. Tässä artikkelissa on aakkosellinen viite.

Lisätietoja on Artikkelissa Learn Markdown -viitetiedot .

Koodikatkelmat

Tarjousten esto

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

Yllä oleva esimerkki hahmonnetaan seuraavasti:

Tämä on muotoiltu lainaus. Se hahmonnetaan yleensä sisennyksinä ja eri taustavärillä.

Koodilohkot

Voit lisätä koodikielen koodilohkoon monipuolisempaa hahmontamista varten.

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

Yllä oleva esimerkki hahmonnetaan seuraavasti:

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

Emojis

Q&A muuntaa emoji-lyhyen koodin vastaaviin Unicode-merkkeihin:

This is a test with a :).

Yllä oleva esimerkki hahmonnetaan seuraavasti:

Tämä on testi, jossa on 😃.

Muotoilu

Voit lihavoida tekstiä ympäröimällä sen kahdella tähtimerkillä:

This text is **bold**.

Voit kursivoida tekstiä ympäröimällä sen yhdellä tähtimerkillä:

This text is *italic*.

Voit lihavoida ja kursivoida tekstiä ympäröimällä sen kolmella tähtimerkillä:

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

Muotoile tekstiä yliviivaukseksi ympäröimällä se kahdella sen ympärillä olevalla aaltoviivalla:

This text is ~~strikeout~~.

Otsikot

Q&A tukee kuutta Markdown-otsikkotasoa:

# This is a first level heading (H1)

## This is a second level heading (H2)

...

###### This is a sixth level heading (H6)
  • Viimeisen #-merkin ja otsikon välissä on oltava välilyönti.
  • Jokaisella kysymyksellä, vastauksella tai kommentilla on oltava yksi ja vain yksi H1-otsikko.

HTML

Jos kirjoitat HTML-sisältöä, sisältöä ei hahmonneta. Sen sijaan se näkyy vain teksti -muodossa.

Kuvat

Learnin mukautettu :::image::: laajennus tukee vakiokuvia, monimutkaisia kuvia ja kuvakkeita.

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

<alt text> on kuvan lyhyt kuvaus ja <folderOrURLPath> on kuvan tai sen URL-osoitteen suhteellinen polku. Vaihtoehtoista tekstiä tarvitaan heikkonäköisten käyttämiä näytönlukuohjelmia varten. Siitä on hyötyä myös, jos sivustolla on virhe, joka estää kuvan näyttämisen. Älä kopioi tiedostojen nimiä käytettäväksi vaihtoehtoisena tekstinä. Älä käytä tätä:

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

Käytä sen sijaan tätä:

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

Linkkejä on helppo lisätä Q&A:ssa. Linkit osoittavat käyttäjät sisältöön toisella sivulla Q&A:ssa tai toisessa luotetussa lähteessä.

[Link text](<FullURL>).

[Microsoft Q&A products page](/answers/products).`

Linkin teksti

Linkin tekstiin sisällytettävien sanojen tulee olla ystävällisiä. Sen on siis koostuttava normaaleista suomenkielistä sanoista tai linkitettävän sivun otsikosta.

Älä käytä "Valitse tästä" -komentoa tekstinä. Se heikentää hakukoneoptimoinnin tuloksia ja kuvailee kohdetta huonosti.

Tärkeä

Kaikkien linkkien on oltava suojattuja (https vs http) aina, kun kohde tukee sitä (useimmissa tapauksissa).

Esimerkki:

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

Yllä oleva esimerkki hahmonuu seuraavasti:

Lisätietoja on Microsoftin Q&A-tuotteiden sivulla.

Linkit muotoillaan automaattisesti kaikille merkkijonoille, jotka alkavat: https://, https://, , ftp://mailto:, , tel:tai www. (jonka ratkaisu on https://www.)

Luettelot (numeroidut luettelot, luettelomerkeillä varustetut luettelot)

Numeroitu luettelo

Jos haluat luoda numeroidun luettelon, voit käyttää pelkkiä ykkösiä. Numerot näytetään nousevassa järjestyksessä peräkkäisessä luettelossa, kun ne julkaistaan. Voit parantaa lähteen luettavuutta suurentamaan luetteloita manuaalisesti.

Älä käytä luetteloissa kirjaimia. Tämä pätee myös sisäkkäisiin luetteloihin. Ne eivät hahmonna oikein julkaisun yhteydessä. Sisäkkäisten luetteloiden numerointi hahmontuu julkaistaessa pieniksi kirjaimiksi. Esimerkkejä:

1. This is
1. a parent numbered list
   1. and this is
   1. a nested numbered list
1. (fin)

Tämä hahmontuu seuraavasti:

  1. This is
  2. a parent numbered list
    1. and this is
    2. a nested numbered list
  3. (loppu)

Luettelomerkeillä varustettu luettelo

Voit luoda luettelomerkeillä varustetun luettelon lisäämällä kunkin rivin alkuun merkin - tai * ja sen perään välilyönnin:

- This is
- a parent bulleted list
  - and this is
  - a nested bulleted list
- All done!

Tämä hahmontuu seuraavasti:

  • This is
  • a parent bulleted list
    • and this is
    • a nested bulleted list
  • Valmista!

Riippumatta siitä, mitä syntaksia käytät tai -*, käytä sitä johdonmukaisesti sisällössäsi.

Taulukot

Yksinkertaisin tapa luoda taulukko Markdownilla on käyttää pystyviivoja ja yhdysmerkkejä. Voit luoda vakiomallisen taulukon otsikoineen lisäämällä ensimmäisen rivin jälkeen katkoviivan:

|This is   |a simple   |table header|
|----------|-----------|------------|
|table     |data       |here        |
|it doesn't|actually   |have to line up nicely!|

Tämä hahmontuu seuraavasti:

This is a simple table header
table tiedot täällä
it doesn't actually have to line up nicely!