Skip to main content

Tutorial Metadata

Metadata helps structure polkadot.study. Docusaurs will create routes and pages from information of your tutorials metadata and e.g. set page headers. That enables users to navigate the website and also find your tutorial easier with search engines. That is why you are encouraged to update the metadata of your tutorial before submitting it.

Front Matter​

Front matter in docusaurus, is a specially formatted text block that will resolve into specific DOM content or other structured data accompaning your tutorial. One example of a complete front matter for a polkadot.study tutorial is

---
tags:
  - contribute
  - polkadot.js
keywords: [tutorial, polkadot]
description: Learn how to write your tutorial on polkadot.study
image: https://i.imgur.com/mErPwqL.png
---

Look at the explanations below to learn about all those parts, and why you should add them.

Author​

Here you should add your name or alias alonsige a short description and link to your portfolio / blog / project.

Tags​

Tags are used to categorize your tutorial. E.g. supplying polkadot.js in thi

Keywords​

  • keywords that will appear when searching your tutorial on search engines -> important for SEO

Description​

  • description that will appear when searching your tutorial on search engines -> important for SEO

Image​

  • if you do not use the image url (local or external) the default image of the first category will be used