https://github.com/zokhoi/vscode-ftml

VSCode extension for support of FTML, the markup language of SCP Foundation
https://github.com/zokhoi/vscode-ftml

scp-foundation scp-wiki vscode vscode-extension wikidot

Last synced: 2 months ago
JSON representation

VSCode extension for support of FTML, the markup language of SCP Foundation

• Host: GitHub
• URL: https://github.com/zokhoi/vscode-ftml
• Owner: Zokhoi
• License: agpl-3.0
• Created: 2022-03-24T18:28:39.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-07T16:35:25.000Z (8 months ago)
• Last Synced: 2024-05-07T17:41:00.982Z (8 months ago)
• Topics: scp-foundation, scp-wiki, vscode, vscode-extension, wikidot
• Language: TypeScript
• Homepage:
• Size: 8.39 MB
• Stars: 19
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# FTML/Wikidot Workshop for VSCode

[![version](https://img.shields.io/vscode-marketplace/v/zokhoi.vscode-ftml.svg?style=flat-square&label=vscode%20marketplace)](https://marketplace.visualstudio.com/items?itemName=zokhoi.vscode-ftml)

A VSCode extension for support of FTML, the markup language of SCP Foundation.

This extension supports only a subset of [Wikidot text](https://www.wikidot.com/doc-wiki-syntax:start) (Wikitext), refered to as [FTML](https://github.com/scpwiki/wikijump/tree/develop/ftml) (Foundation Text Markup Language).

## Features for desktop and web VSCode

* Syntax highlighting

  * applicable to file extensions `.ftml`, `.wd`, `.wikidot`, `.wj`, `.wikijump`

* Wikitext Live preview

![vscode-ftml-live-preview](./docs/vscode-ftml-live-preview.gif)

### Features for desktop VSCode only

* Retreiving Wikidot page wikitext source and metadata

* Diffing between local and remote content

![vscode-ftml-fetch](./docs/vscode-ftml-fetch.gif)

* Pushing local wikitext files to Wikidot

![vscode-ftml-push](./docs/vscode-ftml-push.gif)

## Development

This repository uses pnpm for package management.

Install development dependencies and use

```bash

pnpm run compile

```

for compiling.

## References

* [FTML Blocks documentation](https://github.com/scpwiki/wikijump/blob/develop/ftml/docs/Blocks.md)

* [FTML file specficiation](https://gist.github.com/Zokhoi/06dbc890a4f2fab3eadcd7d2ed0d8698)