preview-vscode

A previewer of Markdown, ReStructured Text, HTML, Jade, Pug, Mermaid files, Image's URI or CSS properties for Visual Studio Code

README

An extension to preview Markdown, ReStructured Text, HTML, Jade, Pug or Mermaid files, Image's URI or CSS while editing them in VSCode

The extension can be activated in two ways

• Toggle Preview
  • Linux & Windows: ctrl+shift+v
  • MAC:cmd+shift+v or ctrl+shift+v
• Open|Close Preview to the Side
  • Linux & Windows: ctrl+k v
  • MAC:cmd+k v or ctrl+k v

Just press the same key when you want to go back to the original view.

DETAIL

• If file type is Markdown, ReStructured Text, HTML, Jade, Pug or Mermaid
  • Just do as the operation as mentioned.
• If file type is CSS
  • Just click on a CSS property between{}
  • Just do as the operation as mentioned.
• If file type is other
  • Just click on a
    • image URI (/http[s]{0,1}://|file://|\s[.]{0,2}//).
      • for example: http://, https://, file://, /, ./
    • css properities ({})
      • for example: {color: blue}
    • others as Markdown, ReStructured Text, HTML, Jade or Mermaid
      • for ReStructured Text, docutils is the first choice, and rst2mdown is plan B.
        • python
        • docutils
    • Just do as the operation as mentioned and a showQuickPick will pop up to show choices.
    • 

Note

python and docutils are recommended to be installed to Preview ReStructured Text to preview the rst more accurately.

Contributing

• If you want to develop and debug this extension from source code, and run 'npm install' under the root dir of this extension,

• npm packages vscode and typescript is needed as an environment

  npm install vscode
  npm install typescript

• Cannot find module 'vscode'? Please run 'npm run postinstall' under the root dir of this extension, according to Cannot find module 'vscode' – where is vscode.d.ts now installed? #2810

  • Error installing vscode.d.ts: Error: connect ETIMEDOUT 51.144.164.215:443
    • npm use npm proxy instead of HTTP_PROXY, so proxy takes no effect if npm_proxy is not set

      • set proxy for npm

        npm config set proxy http://username:password@proxy_server:proxy_port
        npm config set https-proxy http://username:password@proxy_server:proxy_port

      • another way, run 'npm_config_proxy="http://username:password@proxy_server:proxy_port" npm_config_https_proxy="http://username:password@proxy_server:proxy_port" npm run postinstall' instead(npm_config_https_proxy can be ignored if npm_config_https_proxy is the same as npm_config_proxy).

      • execute sudo command with proxy, accroding to Pro Terminal Commands: How and Why To Edit Sudoers on macOS

        # edit /etc/sudoers
        sudo visudo
        # add codes below
        Defaults env_keep += "http_proxy"
        Defaults env_keep += "https_proxy"
        Defaults env_keep += "no_proxy"
        Defaults env_keep += "ftp_proxy"
        Defaults env_keep += "npm_config_proxy"
        Defaults env_keep += "npm_config_https_proxy"
        Defaults env_keep += "HTTP_PROXY"
        Defaults env_keep += "HTTPS_PROXY"
        Defaults env_keep += "NO_PROXY"
        Defaults env_keep += "FTP_PROXY"
        Defaults env_keep += "NPM_CONFIG_PROXY"
        Defaults env_keep += "NPM_CONFIG_HTTPS_PROXY"

• Cannot find module 'console'? Please run 'npm install @types/node' under the root dir of this extension, according to Node projects with --lib es6: cannot find name 'console' #9545

• Node.js's version is too old ? following this two ways, choose one:

  • NodeSource Node.js Binary Distributions, and you will get the latest version installed automatically !
  • install n to maintain the version

    • install module n

      sudo mkdir -p $(npm config get prefix)/n
      sudo chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share,n}
      sudo npm install -g n

    • update Node.js

      • latest stable version

        sudo n stable

      • any version

        sudo n 7.6.0
        sudo n v7.6.0

      • manually update

        • explore for the version you want, click this to explore->>

        • download the node file, such as v7.3.0

          # Broken-point Continuingly-transferring is supported.
          wget -c https://nodejs.org/download/release/v7.3.0/node-v7.3.0-linux-x64.tar.gz

        • install Node.js, such as v7.3.0

          mkdir -p /usr/local/n/versions/node/
          tar -zxvf node-v7.3.0-linux-x64.tar.gz 7.3.0/
          ln -sf /usr/local/n/versions/node/7.3.0/bin/node /usr/bin/node

• Node Package's version is too old? following this way:

  • install module npm-check

    npm install -g npm-check

  • check for installed npm packages's version

    # set flag -g for global packages, else for local packages
    npm-check -u

  • do as npm-check tells

• Meet NPM problem: npm ERR! extraneous when you run npm list? Please run 'npm prune -x' to clean unneeded packages, according to NPM problem: npm ERR! extraneous

• How to publish this extension? Please run 'npm install -g vsce' to install vsce, according to publishing-extension

• Meet This extension consists of 12756 files, out of which 7903 are JavaScript files. For performance reasons, you should bundle your extension: https://aka.ms/vscode-bundle-extension . You should also exclude unnecessary files by adding them to your .vscodeignore: https://aka.ms/vscode-vscodeignore

  • Ignore dependencies of devDependencies

  • vim webpack.config.js, and enable http server for webpack-bundle-analyzer

    - analyzerMode: 'disabled'
    + analyzerMode: 'server'

• 'vsce package && vsce publish' failed?

  Executing prepublish script 'node ./node_modules/vscode/bin/compile'...
  Error: Command failed: node ./node_modules/vscode/bin/compile
  

  • execute this command and you will get the error message in the console

  npm run vscode:prepublish

  • fix the error and retry 'vsce publish'

• Write Your First Extension?your-first-extension

Thanks to

• html-preview-vscode.

• vscode-imagepreview.

• vscode-mermaid-preview.