Skip to content
This repository has been archived by the owner on Feb 8, 2019. It is now read-only.

Latest commit

 

History

History
67 lines (40 loc) · 4.01 KB

README.md

File metadata and controls

67 lines (40 loc) · 4.01 KB
Raw

Argdown for Visual Studio Code

Argdown is a simple syntax for analyzing argumentation, inspired by Markdown. This extension provides the following features for Argdown:

  • Syntax highlighting
  • Linting
  • Html, Dot and JSON Export

The extension is still in its alpha phase. More features and better documentation will be added over time.

For more information about the Argdown argumentation syntax visit the central Argdown repository.

Activating the Argdown theme

Standard themes do not highlight Argdown attack and support relations. For complete syntax highlighting, please activate the Argdown theme:

  1. Go to Code/Preferences/Color Theme in the main application menu
  2. Select Argdown Theme from the list of available themes

The Argdown theme is the default VS Code light theme, enhanced by some Argdown-specific features, so it will also work with other languages.

We hope that VS Code will add support for language-specific themes in the future, so that the Argdown theme will only be active for Argdown files.

Exporting Argdown files to HTML, Dot and JSON

The extension contributes four new commands to the command palette:

  • 'Argdown: Export Argdown files to HTML'
  • 'Argdown: Export Argdown files to JSON'
  • 'Argdown: Export Argdown files to Dot'
  • 'Argdown: Run Argdown parser with config file'

To access these commands, open the command palette (CTRL + Shift + P on Windows/Linux or CMD + Shift + P on OSX), type in Argdown and select the command you want to execute.

By default the export commands will export all Argdown files in each workspace folder. To configure which files to export or at which path you want to save the exported files, you can change the Argdown settings (see below).

In the future, we will try to integrate these exports commands into the general user interfacen and add additional export options.

Configuration

Basic configuration options are available directly in the VS Code preferences. For advanced configuration you can use a argdown.config.js file.

Choosing which files to export

If you do not want to export all Argdown files in the workspace, you can select the files to export by using a file "glob" selector in the VS Code settings. VS Code allows you to define globals settings, settings for the current workspace or settings for the current workspace folder. To change the settings for the current folder, do the following:

  1. Open the preferences by selecting Code/Preferences/Settings from the main application menu or by pressing CTRL + , on Windows/Linux or CMD + , on OSX.
  2. On the right side you can define your settings. Select the folder settings tab.
  3. Add the following setting to only export .argdown files in the argdown folder to HTML: "argdown.htmlExportInput: argdown/*.argdown"

For selecting which files to export to Dot or JSON, use argdown.dotExportInput and argdown.jsonExportInput.

Choosing where to export files to

By default, HTML files are saved in a ./html folder, json files in a ./dot folder and JSON files in a ./json folder. To export all files to an export directory, do the following:

  1. Open the preferences by selecting Code/Preferences/Settings from the main application menu or by pressing CTRL + , on Windows/Linux or CMD + , on OSX.
  2. On the right side you can define your settings. Select the folder settings tab.
  3. Add: "argdown.htmlDirectory: export"
  4. Add: "argdown.dotDirectory: export"
  5. Add: "argdown.jsonDirectory: export"

Using argdown.config.js for advanced configuration options

You can create argdown.config.js files in your workspace folders to change the way the Argdown commands are executed. Using config files you can achieve anything you can do with the Argdown Commandline Interface.

Visit the config documentation at the central Argdown repository to learn more about the format of the config file.