/freestylewiki-live-viewer-vscode

Live preview FreeStyleWiki (a.k.a FSWiki, FSW) file for VSCode.

Primary LanguageCSSApache License 2.0Apache-2.0

FreeStyleWiki Live Viewer for VSCode

Version Lint Test

Live preview FreeStyleWiki (a.k.a FSWiki, FSW) file for VSCode.

Install

Download on the Visual Studio Marketplace.

Getting Started

  1. Open your FreeStyle Wiki Article (.fsw, .fswiki extension file).

  2. Open this extension with command pallet.

    • On macOS.

      1. Command + Shift + p to open command pallet.
      2. Put fslive.
      3. Select FreeStyleWiki Live Viewer.

    • On Windows.

      1. Ctrl + Shift + p to open command pallet.
      2. Put fslive.
      3. Select FreeStyleWiki Live Viewer.

  3. Enjoy 🎉

Supported File Extensions

  • .fsw
  • .fswiki

How to Contribute

  1. Clone freestylewiki-live-viewer-vscode repository.

  2. Install dependencies.

npm install

  1. Make changes.

  2. Compile TypeScript files.

npm run compile

  1. Push F5 key on VSCode and enjoy debugging.

  2. Run tests.

npm lint
npm test

Build

if you want export to .vsix file, run below command.

npm run build

How to add a grammar with paragraph plugins to the parser

  1. Open settings.json

    • On macOS.

      1. Command + Shift + p to open command pallet.
      2. Put > settings.
      3. Select Preferences: Open Settings (JSON).

    • On Windows.

      1. Ctrl + Shift + p to open command pallet.
      2. Put > settings.
      3. Select Preferences: Open Settings (JSON).

  2. Add fs-live-viewer.pluginParseSettings to the settings.json file.

    • if you want to add pre plugin to the parser, add below code.
...

"fs-live-viewer.pluginParseSettings": [
    {
        "parseFSWTemplate": "{{pre\n$1\n}}",
        "parseHTMLTemplate": "<pre>$1</pre>",
    }
],

...
  1. Reopen FreeStyleWiki Live Viewer.

License

Apache License 2.0. See LICENSE file for more information.

The Logo

The Logo created by DALL-E 3 AI.

Reference