Skip to content

Rebass components integration with Docusaurus

Following the discussion in #5 (closed):

Implement a js library of simple (React-)Rebass components that can be used from inside *.md files, i.e., directly importable in the source code of existing static websites. If possible, the underlying Docusaurus infrastructure should remain unaltered (this seems to be possible due to this feature).

Displayable content (text) of these elements should be configurable by means of 1-2 self-explanatory parameters upon initialization. Functionality should instead be common to all of them, so that all components could inherit from the same one supporting

(a) link to some page with extensive info

(b) text popup upon hovering

(c) some other dynamical stuff we might come up with in the future

Initialization within the *.md file should be seamless, following some simple pattern like

This is md content, but this <Actor 
     text="Some info about this word" 
     link="/glossary/actor">word</Actor> here has a popup!

Usage of <... glossary="true"/> as proposed in #5 (closed) for glossary generation needs to be further clarified (@rieks.joosten).

@kathan @gtsouk