Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

Lightning-Universe/MarkDown-poster_component

Repository files navigation

A Lightning component to create Markdown Poster


Lightning license CI testing

About

This component lets you make posters from Markdown to the Lightning app.


Use the component

from lightning.app import LightningFlow, LightningApp
from poster import Poster


class CustomPosterApp(LightningFlow):
    def __init__(self):
        super().__init__()
        self.poster = Poster(resource_dir="resources")

    def run(self):
        self.poster.run()

    def configure_layout(self):
        return {"name": "Poster", "content": self.poster.url + "/poster.html"}


if __name__ == "__main__":
    app = LightningApp(CustomPosterApp())

install

Use these instructions to install:

Lightning CLI

lightning install component lightning/lit-markdown-poster

Manual

git clone https://github.com/PyTorchLightning/markdown-poster.git
cd markdown-poster
pip install -e .

Note: This component isn't compatible with Windows.

Learn more about this here

About

This component lets you make posters from Markdown files.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages