Markdown
Her forklares noen fine funksjoner som kan brukes i markdown‑filene.
Github markdown
Bruke ikoner 👍 👏 👏
Ikoner kan brukes i markdown‑filene. Dette gir dokumentasjonen et mer vennlig utseende 😃
Her er en lenke til ikoner som kan brukes:
Markdown‑komponenter
Vi har lagt til den første av flere markdown‑komponenter. Markdown‑komponenter er NHN‑spesifikke komponenter som kan rendres i ethvert markdown‑dokument ved hjelp av en forhåndsdefinert syntaks. Den første makro‑komponenten er linkbox; disse kan rendres enkelt (stablet vertikalt) eller i et rutenett (2 per rad).
Markdown‑komponenter opprettes med enkel HTML‑syntaks. Følgende komponenter er foreløpig tilgjengelige:
Linkbox‑rutenett
Link‑bokser kan rendres som et rutenett (2 bokser per rad) eller stablet vertikalt.
Link‑bokser legges til med følgende syntaks:
Eksempel på syntaks:
<mdlinkboxgrid title="Linkbox grid!">
<mdlinkbox url="https://www.google.com" title="Linkbox 1!" description="description here!" newtab="true"></mdlinkbox>
<mdlinkbox url="https://www.google.com" title="Linkbox 2!" description="description here!" newtab="false"></mdlinkbox>
<mdlinkbox url="https://www.google.com" title="Linkbox 3!" description="description here!" newtab="true"></mdlinkbox>
<mdlinkboxgrid>
Linkbox‑rutenett – rendrer linkbokser i rader med 2 elementer per rad
Obligatorisk felter: [url, title (not Obligatorisk on grid element)]
Linkboxes - vertikalt
Link‑bokser kan også stables vertikalt ved å utelate den omsluttende
Enkelte linkbokser vil da bli stablet vertikalt
<mdlinkbox url="https://www.google.com" title="Linkbox 1!" description="description here!" newtab="true"></mdlinkbox>
<mdlinkbox url="https://www.google.com" title="Linkbox 2!" description="description here!" newtab="false"></mdlinkbox>
Obligatorisk felter: [url, title]
Dette eksemplet vil rendere linkbokser i et rutenett som vist nedenfor:
This example will render link boxes in a grid as shown below:
Link button
Den andre makro‑komponenten er link‑button. Akkurat som linkbokser kan disse rendres på flere måter: enten stablet vertikalt eller horisontalt. I motsetning til linkbokser er det ingen grense for hvor mange knapper som kan vises i én rad.
Eksempel på syntaks:
Stable linkboxes horisontalt
<mdlinkbutton url="https://www.vg.no" title="Single macro link button 1" newtab="true" single="false"></mdlinkbutton>
<mdlinkbutton url="https://www.vg.no" title="Single macro link button 2" newtab="false" single="false"></mdlinkbutton>
Obligatorisk felter: [url, title]
This example will render linkbuttons and stack these horizontally as shown in the example below:
For å stable link‑knapper vertikalt trenger du kun å sette attributtet single til true
<mdlinkbutton url="https://www.vg.no" title="Single macro link button 1" newtab="true" single="true"></mdlinkbutton>
<mdlinkbutton url="https://www.vg.no" title="Single macro link button 2" newtab="false" single="true"></mdlinkbutton>
Obligatoriske felter: [url, title]
Dette eksemplet vil rendere link‑knapper og stable dem vertikalt slik det vises i eksemplet nedenfor:
Dropdown
Dropdowns kan brukes til å visualisere innhold som ellers ville blitt presentert i en vanlig liste, for å gi sluttbrukeren et mer visuelt og interaktivt grensesnitt. Når lister inneholder mye innhold, kan dropdown‑menyer spare plass og la brukerne finne relevante avsnitt mye raskere.
Opprett én eller flere dropdown‑menyer med følgende syntaks:
<mddropdown title="Macro dropdown 1" content="This is a dropdown macro component!"></mddropdown>
<mddropdown title="Macro dropdown 2" content="This is once again a dropdown macro component!"></mddropdown>
Required fields: [title, content]
Dette eksemplet vil rendere to dropdown‑menyer og stable dem vertikalt slik det vises i eksemplet nedenfor:
Det er ingen begrensning på hvor mange dropdown‑menyer som kan legges til i ett markdown‑dokument.
Grupper kodeeksempler
Utviklerportalen støtter kodeeksempler på flere språk. Når API‑ene dine støtter mange ulike programmeringsspråk kan det være praktisk å gruppere dem i faner, slik at brukeren kan se kodeeksemplene i ønsket språk. Dette reduserer både lengde og rot i markdown‑dokumentene, og dev‑portalen støtter dette nå!
Vi bruker en funksjonelt utvidet markdown‑parser for å bygge disse komponentene. På samme måte som med våre andre markdown‑komponenter finnes det dessverre ingen mulighet for forhåndsvisning i markdown‑editoren. Du vil imidlertid se resultatet når dokumentene dine er synkronisert inn i dev‑portalen!
Ved å bruke følgende syntaks kan du lage et gruppert kodeeksempel hvor hvert programmeringsspråk får sin egen fane basert på språket som er angitt i starten av eksemplet:
<mdcodesamples>
```json <-- LANGUAGE MUST BE SPECIFIED
{
"property 1": "true",
"property 2": "xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"property 3": "250"
}
```
```javascript
function testFunction(){
console.log('this is a test function');
}
```
```csharp
public class TestClass{
public string Name {get; set;}
public int Age {get; set;}
public bool IsHappy {get; set;}
}
```
</mdcodesamples>
MERK: De tomme linjene mellom <mdcodesamples> og resten av innholdet er påkrevd for at markdown‑parseren skal fungere korrekt. En tom linje er også påkrevd før </mdcodesamples>. En annen viktig regel er at kode‑språket (eller navnet) må angis for hvert eksempel, som vist i eksemplet ovenfor. Vi anbefaler å bruke kode‑språk, da vi på et tidspunkt vil implementere syntaks‑utheving for alle gjenkjente språk.
Når koden er satt opp riktig, vil den ovenfor bli tolket til et kodeeksempel med faner, som vist nedenfor:
{
"property 1": "true",
"property 2": "xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"property 3": "250"
}
function testFunction(){
console.log('this is a test function');
}
public class TestClass{
public string Name {get; set;}
public int Age {get; set;}
public bool IsHappy {get; set;}
}
Dette dekker hvordan du kan gruppere kodeeksempler i faner, og dermed redusere lengden på markdown‑dokumentene dine.
Vi håper du synes disse tilpassede markdown‑komponentene er nyttige når du bygger dokumentasjonen din!
Dette er komponentene som foreløpig er tilgjengelige i markdown‑dokumenter; flere vil bli lagt til etter hvert som behovet oppstår. Har du idéer eller krav i den retningen, er du velkommen til å kontakte oss!