In questo task viene descritta la modalità di consultazione della documentazione rivolta all'utente direttamente nell'hub.
Prerequisiti
Dovremo creare una libreria js custom che usi basa sulla libreria MarkedJs già utilizzata dal componente Markdown di homeassistant.
La libreria al click su un punto preciso dell'interfaccia espone all'utente la parte di documentazione richiesta. La consultazione può avvenire reindirizzando l'utente su una pagina adatta alla consultazione estesa della documentazione. Il contenuto della documentazione è in markdown, quindi elementi grafici come icone, badge, alert etc sono gli stessi del tema di homeassistant.
Markdown plugin
[x] POC
[ ] Intregrazione Hassio
POC
Sviluppare una libreria JS (stile notifiche) che prende in input i seguenti parametri:
baseUrl (input_text.baseUrl)
version (sensor.kairoshubSwVersion)
section (valore della sezione, ad esempio heatinglighthomesettings etc)
La libreria accoglie gli input richiede attraverso l'url baseUrl/version il contenuto remoto (per lo sviluppo può stare anche su un file locale) una volta ottenuto il documento remoto viene visualizzato come di seguito:
import { marked } from 'marked';
// or const { marked } = require('marked');
const html = marked.parse('# Marked in Node.js\n\nRendered by marked.');
l'html viene renderizzato e l'utente viene posizionato nella sezione section richiesta dall'utente. Si possono generare testi casuali più o meno lunghi online.
christianorsini
commented
1 year ago
Documentazione utente
In questo task viene descritta la modalità di consultazione della documentazione rivolta all'utente direttamente nell'hub.
Prerequisiti
Dovremo creare una libreria js custom che usi basa sulla libreria MarkedJs già utilizzata dal componente Markdown di homeassistant. La libreria al click su un punto preciso dell'interfaccia espone all'utente la parte di documentazione richiesta. La consultazione può avvenire reindirizzando l'utente su una pagina adatta alla consultazione estesa della documentazione. Il contenuto della documentazione è in markdown, quindi elementi grafici come icone, badge, alert etc sono gli stessi del tema di homeassistant.
Markdown plugin
POC
Sviluppare una libreria JS (stile notifiche) che prende in input i seguenti parametri:
heatinglighthomesettingsetc)La libreria accoglie gli input richiede attraverso l'url
baseUrl/versionil contenuto remoto (per lo sviluppo può stare anche su un file locale) una volta ottenuto il documento remoto viene visualizzato come di seguito:l'html viene renderizzato e l'utente viene posizionato nella sezione
sectionrichiesta dall'utente. Si possono generare testi casuali più o meno lunghi online.Integrazione Hassio
TBD