Something I'm working on ...

MichMich

If you work on such an installer. Make sure it’s based on the module infrastructure where possible. That we you can develop and test is, without the need of directly integrating it in mm2. If It’s fully up and running and tested, we can integrate it by adding it to the list of default modules.

Cato

@MichMich I noticed that format of table markdown is not optimal. The rows should be alternating color. A good example that current format is bad is here: http://beta.magicmirror.builders/module/29/motioneye. Notice that it’s difficult to see what configuration value belongs to which description…

LukeCodewalker

Hey,
another problem with tables:

if you use html-tables in your GitHub README.md it’s not displayed the right way.
Example: http://beta.magicmirror.builders/module/33/soccerlivescore

chrisfoerg

It is only an idea. In Wordpress the themes have all the same style at the beginning in the css file for the declaration of the theme:

/*
Theme Name: Tutorial
Theme URI: http://wordpress.lernenhoch2.de
Description: Template zum WordPress Tutorial auf http://wordpress.lernenhoch2.de
Author: Christian Strang
Author URI: http://lernenhoch2.de
*/

https://codex.wordpress.org/Theme_Development#Theme_Stylesheet

maybe it is something for you to use?

MichMich

@LukeCodewalker It seems the html is malformed and thus the markdown parser in unable to parse it correctly. It looks like the table contains white lines which are not allowed. If you run your markdown thru a markdown linter, you’ll see there is an issue with the markdown of that readme file.

Cato

@MichMich I guess both @LukeCodewalker and me have the same issue. I’ve included my markdown below and as far as I can see there should be no issue with it. The only thing might be the inclusion of
tags for new line.

Configuration option | Comment | Default 
---|---|---
url | Video Streaming URL.<br><br>You find it in <i>Motion Eye</i> in the <i>Video Streaming Section</i> under <i>Usefull URLs</i> by by clicking the <i>Streaming URL</i> link.<br><br>It should look something like this: `http://motioneye:8081` (probably an IP instead of hostname) | No default
autoHide | If you want the camera to only be visible on the mirror when there is motion, set this to true. You will then have to enable "Call a Web Hook" in Motion Eye under the Motion Notifications section: <br><br> - Web Hook URL: <b>[http://URL of your mirror]/motioneye</b>. Example: http://192.168.1.11:8080/motioneye<br> - HTTP Method: <b>GET</b><br><br>Remember to update IP white list to enable access from your Motion Eye box.|false
autoHideDelay|If autoHide is enabled you can decide how long to wait before hiding the camera|60000 (60 seconds)
width|Width of camera image. You have to try out what fits YOUR monitor | 400px
debug|Show messages in the log|false

MichMich

@Cato That’s correct. You’re mixing html and markdown. Which is not supported within a markdown table. The markdown parser is very strict about this due to security reasons. (We want to prevent code injection via a readme file at all costs.)

I just use the parser used/developed by/for https://www.npmjs.com, so this is not something I can change.

Cato

@MichMich Are you sure about that?

I thought InLine HTML was perfectly allowed. See:

MichMich

@Cato Yes, it’s allowed, but not within a markdown table.

Cato

Ok, I’ll reformat my documentation when I get time.

I found this nice tool: https://dlaa.me/markdownlint/ for checking syntax.