Skip to content

Latest commit

 

History

History
134 lines (89 loc) · 4.82 KB

README.md

File metadata and controls

134 lines (89 loc) · 4.82 KB
Raw

docs.fdnd.nl

GitHub issues Code style: prettier License: GPL-3.0

Beschrijving in documenten van de Associate degree Frontend Design & Development, een opleiding van de Hogeschool van Amsterdam op niveau 5.

Bijdragen

Al onze niet AVG gevoelige informatie is publiek toegankelijk. Als je het ergens niet mee eens bent, als je foutjes ontdekt of als je een bijdrage hebt dan staat het je vrij aanpassingen te maken en een pull-request in te schieten. Je kunt natuurlijk ook gewoon een issue schrijven, kies daarbij alsjeblieft het juiste issue template.

Installatie

Als je wilt bijdragen is het handig als je dat op jouw lokale machine kunt doen. Volg onderstaande stappen om de omgeving lokaal te installeren.

  1. Fork deze repository
  2. Clone jouw forked repository naar je lokale omgeving
  3. Voer npm install uit
  4. Maak de aanpassingen die je wilt maken. In de docs map staan de documenten in markdown formaat en in de src map staan de bestanden die gebruikt worden voor het parsen van de documenten.
  5. Voer npm run dev uit om een ontwikkelomgeving te starten. Wijzigingen in de src én in de docs map triggeren een rebuild welke automatisch herladen wordt in de browser.

Documentatie

Ondersteunde Markdown syntax

Docs.fdnd.nl gebruikt GitHub Flavored Markdown (GFM) om Markdown bestanden te parsen. Hierdoor worden een aantal extensies ondersteund bovenop de standaard Markdown specificatie. Daarnaast wordt ook Shiki gebruikt om codevoorbeelden te highlighten. Hieronder enkele highlights van de syntax die je in Docs.fdnd.nl kunt gebruiken.

Tabellen

Eenvoudige tabellen kunnen in GFM met pipes (|), hyphens (-) en dubbele punten (:) gemaakt worden. Voor meer ingewikkelde tabellen is het handiger direct HTML codes op te nemen.

Voorbeeld

De volgende tabel in markdown

| foo | bar |
| --- | --- |

wordt geparsed naar

<table>
  <thead>
    <tr>
      <th>foo</th>
      <th>bar</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>baz</td>
      <td>bim</td>
    </tr>
  </tbody>
</table>

Takenlijsten

Door het toevoegen van een linkerbracket ([), een rechterbracket (]) en optioneel de letter x kan van een standaard lijst een takenlijst gemaakt worden. Deze worden vervangen door een semantisch checkbox element, in HTML is dit <input type="checkbox">.

Voorbeeld

De volgende lijst in markdown

- [ ] foo
- [x] bar

wordt geparsed naar

<ul>
  <li><input disabled="" type="checkbox" /> foo</li>
  <li><input checked="" disabled="" type="checkbox" /> bar</li>
</ul>

Doorhalen

Je kunt tekst binnen dezelfde alinea tussen één of twee tildes (~) zetten om het door te halen. Dit kan handig zijn om te laten zien dat er iets veranderd is in een document.

Voorbeeld

De volgende regel in markdown

~~Hoi~~ Hallo, ~~daar~~ wereld!

wordt geparsed naar

<p><del>Hoi</del> Hallo, <del>daar</del> wereld!</p>

Autolinks

Je kunt links en emailadressen tussen < en > plaatsen en die worden automatisch geparsed naar html-anchor elementen met de URL of het email adres als inhoud. Een autolink bestaat uit een < gevolgd door een absolute URL gevolgd door >. Een absolute URL bestaat uit een schema gevolgd door : gevolgd door nul of meer ASCII karakters met uitzondering van witruimte en >. Een email autolink bestaat uit een < gevolgd door een email adres gevolgd door een >.

Voorbeeld

De volgende regel in markdown

Je kunt <http://fdnd.nl> bereiken via <[email protected]>.

wordt geparsed naar:

<p>Je kunt <a href="http://fdnd.nl">http://fdnd.nl</a> bereiken via <a href="mailto:[email protected]">[email protected]</a></p>

Code highlighting (Shiki)

Shiki wordt gebruikt met het monokai kleurenschema. Als je code in je tekst opneemt, begin dan met drie backticks (`) gevolgd door de afkorting van de taal die je gebruikt: html, css, js, json, svelte (en vele andere). Jouw code wordt dan door Shiki vertaald naar html-code met inline color-coding volgens monokai.

Referenties

Docs.fdnd.nl maakt gebruik van de volgende npm-packages:

  • Voor het parsen van markdown gebruiken wij vele pakketten uit het Unified collectief.
  • Voor het netjes weergeven van code gebruiken wij de Shiki syntax highlighter.

License

GPL-3.0 license