This repository has been archived by the owner. It is now read-only.
No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.paket
lib
release
src
.gitignore
Ionide.WebView.sln
LICENSE
README.md
RELEASE_NOTES.md
build.cmd
build.fsx
build.sh
paket.dependencies
paket.lock

README.md

[Project is deprecated, we suggest to use VSCode version of Ionide instead]

Ionide-Webview

It's part of Ionide plugin suite. In-editor preview of web applications.

Configuration

ionide-webview allows the user to override the default conventions used to run and preview web applications. To do so You need to create an .ionide file in the root folder of Your project opened by Atom. The configuration file uses the TOML language.

Here is the default configuration values used if the .ionide file doesn't exist or some entry is missing:

[WebPreview]
linuxPrefix = "mono"
command = "packages/FAKE/tools/FAKE.exe"
host = "localhost"
port = 8888
script = "build.fsx"
build = "Serve"
startString = "listener started"
parameters = []
startingPage = ""
  • linuxPrefix - command used as prefix on Linux / Mac - usually sh or mono

  • command - path to FAKE.exe

  • host - address of webpage displayed in WebPreview - usually localhost

  • port - port of webpage displayed in WebPreview (also passed to FAKE as environmental variable)

  • script - FAKE build script passed to FAKE - usually build.fsx

  • build - FAKE build target executed to start WebPreview

  • startString - string which needs to be printed out in standard I/O to let know WebPreview to display webpage

  • parameters - list of parameters passed to FAKE.exe

  • startingPage - webpage displayed in WebPreview - usually or index.html

Join the chat at https://gitter.im/ionide/ionide-project -- Need Help? You can find us on Gitter

Build

  • Clone this repository
  • Run build.cmd (for Windows) or build.sh (for Linux / Max) to build projects
  • Go to release folder and run apm link to create symbolic link between plugin and Atom's plugins folder
  • Run Atom

Contributing and copyright

The project is hosted on GitHub where you can report issues, fork the project and submit pull requests.

The library is available under MIT license, which allows modification and redistribution for both commercial and non-commercial purposes.