Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 4.88 KB

README.md

File metadata and controls

77 lines (52 loc) · 4.88 KB

Textile Language Features

Marketplace Version Build Status CII Best Practices

Full featured document live preview for the Textile markup language.

Beta version !! See the Roadmap.

Based on the source code of Visual Studio Code's Markdown preview, it uses a modified version of textile.js Textile to HTML parser in order to display live preview.

Working with Textile

Create or open any file with a .textile extension, and then you can toggle the visualization of the editor between the code and the preview of the Textile file. To switch between views, press (Ctrl+Shift+V) in the editor. You can view the preview side-by-side (Ctrl+K V) with the file you are editing and see changes reflected in real-time as you edit.

Demo

Features

This extension is entirely based on the Markdown preview provided by Visual Studio Code, and tries to offer the same functionalities :

  • you can view Textile source and its HTML preview side by side, with synchronised scrolling;
  • you can include images, from local or network, with manageable security of the preview's content;
  • the preview supports VSCode light and dark themes;
  • the extension is translated to the 9 VScode core languages;
  • ...

To see the full list of features and interactions, you can read the documentation of the Visual Studio Code's Markdown preview.

Missing features

For now, some features of the original Markdown preview have been disabled.

Features considered out of scope of this extension :

Features to be implemented / triaged :

  • Make all links clickable in the source document (linkProvider)
  • Paragraph folding
  • Generation of table of content, and table of symbols
  • Support 'linkify' option

Release Notes

See CHANGELOG.md.

Roadmap

All bugs and enhancements are tagged to create the following roadmap, materialized through GitHub Projects :

  • Road to the first RELEASE 1.0.0 :
    Fix bugs, and improve documentation and community guidelines.
  • then FUTURE :
    Implement missing features (see above), keep in sync with VSCode updates, ...
    All remaining ToDOs and issues will be triaged and planned after the first release, in new GitHub projects to track progress fir future release.

Support this project

You can support this project by :

License

This project is licensed under the terms of the MIT license.

It is entirely based on :

It includes a modified version of textile-js under the terms of the MIT license.

The Textile logo mark is from Textile logo marks under Creative Commons CC0 1.0 Universal (CC0 1.0) License.