docs: document new markdown web component

[peterpeterparker]

Documentation

A new component markdown has been developed and published.

The goal of this issue is to document it in our documentation for developers.

Route

This component is not yet documented therefore, it should be in a new route:

https://docs.deckdeckgo.com/components/markdown

What do do

To add a new page, the math example can be followed.

1. Add a new TSX component app-markdown (see app-math source as example). The render content does not matter as it will be parsed at build time aka will be overwrite later with the related markdown file.

2. Add a new route in app-root

3. Create the documentation in markdown. The math example can be followed.

Note that there is no live reload to parse the markdown to JSX. Restart npm run start to populate the changes.

Particularity

Note that the particularity of this web component is that it expose two peerDependencies. It renders code to our web component @deckdeckgo/highlight-code and @deckdeckgo/lazy-img, these have to be installed too in the app which would use this new @deckdeckgo/markdown component. Therefore this have to be documented too.

Get started

git clone https://github.com/deckgo/deckdeckgo
cd deckdeckgo/docs
npm i
npm run start

Get Started

If you need help to get started with this feature, I'll be happy to help.

Ping me: @peterpeterparker | twitter | email | slack