Command-line tool

By default, the live preview server only accepts network connections the same computer.

If you want to see the live preview page from another computer on your local network (e.g. a phone or tablet connected to the same Wi-Fi), you'll need to specify --allow-external-connections, which will accept connections from any computer. In networking terms, the server will listen on 0.0.0.0 instead of 127.0.0.1.

This will accept connections from any computer that can send network packets to your computer. But with most network routers / internet connections, you're behind a NAT and other computers probably cannot talk to yours unless they're on the same LAN.

Some service such as ngrok can help in that scenario.

The initial message now includes more information:

$ mm live-preview --allow-external-connections

  Now accepting connections from any computer, due to the --allow-external-connections option.

  Note: if you want to enable HTTPS/TLS, use the --tls option

→ QR code: http://192.168.1.456:3000/qr?access_token=9f5be4be61e6f53172434da1c473d778

→ LAN URL: http://192.168.1.456:3000/?access_token=9f5be4be61e6f53172434da1c473d778

Note: this might be accessible from the internet via a different IP, depending on your network configuration.

TODO

In most contexts, you don't need this option.

• If there are zero .MarkdownMesh.json files in the input zip, then docset root defaults to root of the zip.
• If there is exactly one, then docset root defaults to the dir which contains the config JSON file.
• If there are multiple, then zip2zip will error unless you specify the --docset-root.

For example, suppose you have this file layout:

some-monorepo/
  foo/
    site/
      .MarkdownMesh.json
      ...
    src/
      ...
  bar/
    site/
      .MarkdownMesh.json
      ...
    src/
      ...

...and that you want to pass the entire monorepo as a zip file to zip2zip.

Possible reasons for this include:

• pages within foo/site/ want to use assets that live outside of foo/
• pages within foo/site/ want to import fragments of code (to CodeBlock elements) from bar/src/
• pages within foo/site/ want to import fragments of Markdown (as parts of the doc) from bar/site/
• pages within foo/site/ want to link to a sections of a pages within bar/site/ using a relative Markdown link like [](../bar/site/….md#…) that gets converted to a URL based in part on the url_root in bar/site/'s config JSON.

In this scenario, you'll need to specify --docset-root foo/site/