Skip to content

Commit

Permalink
yarn fix:markdownlint
Browse files Browse the repository at this point in the history
  • Loading branch information
kachkaev committed Nov 12, 2023
1 parent e5dad9d commit 31e8b64
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 9 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,13 @@ Litvis documents can be viewed and created in the _VS Code_ editor:
- Search for `elm tooling` and install _(syntax highlighting of Elm code)_.
1. Configuring Your Editor
To make using litvis as smooth as possible, we recommend the following editor configuration options:
- Under `Preferences->Settings`, change the following from their default settings:
- `Text Editor -> Formatting`: ensure `Format On Save` is ticked
- `Extensions -> Markdown Preview Enhanced with litvis`: ensure `Live Update` is _not_ ticked.
You should now be good to go! Get started by [writing your first litvis document](documents/tutorials/introduction/intro1.md) and looking at these [tutorials](documents/tutorials/README.md).
Expand Down
2 changes: 0 additions & 2 deletions documents/tutorials/introduction/installingLitvis.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ _You can skip this step if you already have Node.js and npm working on your syst

- **Download and install the 'LTS' (Long Term Support) version of Node from [nodejs.org/en/](https://nodejs.org/en/), accepting the default values during installation.**


## Step 2: Install Elm

Litvis uses the programming language _Elm_ to specify visualizations and process data. To install Elm, click the relevant installation for your computer from the [official Elm install page](https://guide.elm-lang.org/install/elm.html) (there's no need to follow the _"after installation is complete..."_ tests).
Expand Down Expand Up @@ -78,7 +77,6 @@ VSCode is a general, but powerful editor that may be customised with 'extensions

- **You can now close the `Settings` tab.**


## Step 7: Check Litvis now works in VSCode

The easiest way to do this is to [write your first litvis document](intro1.md).
8 changes: 3 additions & 5 deletions documents/tutorials/introduction/intro1.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,13 @@ But litvis is more than a markdown editor for text. You can also write, edit and

## Providing a visualization specification

Let's start with a simple litvis document that displays a bar chart.
Let's start with a simple litvis document that displays a bar chart.

First open the _folder_ in VSCode that corresponds to your litvis project folder. If this is the first time you have opened that folder in VSCode you will probably see a dialogue similar to the following:

![VSCode Security dialogue](images/vsCodeSecurity.png)

You should **click the `Yes, I trust the authors` button** to start your VSCode project.

![VSCode Security dialogue](images/vsCodeSecurity.png)

You should **click the `Yes, I trust the authors` button** to start your VSCode project.

Create a new document called [`helloLitvis.md`](helloLitvisV1.md) and copy the following into it.

Expand Down

0 comments on commit 31e8b64

Please sign in to comment.