egoist / egoist/vmark-loader

Documentation: mention that you will need a shim so tsc doesn't complain

Open
#4 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
24
Forks
4
PR merge metrics
No merged PRs in 30d

Description

If you're writing typescript Vue code, tsc will complain when you do `import Doc from 'Doc.md'`. You need to add a shim (ambient typescript module declaration) to tell tsc that a `.md` is a Vue component:
```
% cat src/shims-md.d.ts
declare module '*.md' {
import Vue from 'vue'
export default Vue
}
```

Otherwise when building, you will get errors about missing components.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.