https://github.com/nricciardi/nmd-vscode
Official NMD extension for VS Code
https://github.com/nricciardi/nmd-vscode
nmd vscode-extension
Last synced: 3 months ago
JSON representation
Official NMD extension for VS Code
- Host: GitHub
- URL: https://github.com/nricciardi/nmd-vscode
- Owner: nricciardi
- Created: 2024-07-11T20:39:24.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T14:50:54.000Z (10 months ago)
- Last Synced: 2025-01-12T23:31:03.846Z (5 months ago)
- Topics: nmd, vscode-extension
- Language: HTML
- Homepage:
- Size: 762 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# NMD x VS Code
This is the official VS Code extension to easily use [NMD](https://github.com/nricciardi/nmd).
## Configure extension
1. Install `nmd` with Cargo or through [Github release](https://github.com/nricciardi/nmd) (you must modify `PATH` environment variable)
```shell
cargo install nmd
```
2. Verify installation
```shell
nmd -V
```
## Commands
Run a command using `Ctrl + Shift + P`
### Create new dossier
Create a new dossier in selected path and then open it.
```shell
nmd generate dossier -p -f
```
### Add document to dossier
Add a document to the opened dossier in workspace.
```shell
nmd dossier -p add -d `
```
### Compile (current) dossier
Compile the opened dossier (in workspace, `current`) or a selected one.
```shell
nmd compile -m -f html --force dossier -i -o /build/.html`
```
### Compile file
Compile selected file.
```shell
compile -m -f html --force file -i -o
```
### Watch current dossier
Watch and compile current dossier in workspace. This command doesn't use `nmd compile -w dossier`, but it watches files (ignoring `build/*.html` preventing compilation loops) directly using `chokidar` library.