histoire-dev / histoire-dev/histoire

Markdown docs throw error in terminal on change + save

Open
#207 2 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
TypeScript
Stars
3.6k
Forks
212
PR merge metrics
No merged PRs in 30d

Description

### Describe the bug

When using the markdown documentation as described here: https://histoire.dev/guide/vue3/docs.html#markdown
it shows the markdown we would expect under the docs tab, but when changing/enhancing the markdown and then saving the file so that view updates to latest changes, the terminal throws errors on unexpected characters:

Bildschirmfoto 2022-07-27 um 16 32 26

### Reproduction

https://stackblitz.com/edit/histoire-vue3-markdown-docs-error?file=src%2FBaseButton.story.vue

### System Info

```shell
System:
OS: macOS 12.1
CPU: (8) x64 Apple M1
Memory: 22.74 MB / 16.00 GB
Shell: 5.8 - /bin/zsh
Binaries:
Node: 16.13.1 - ~/.nvm/versions/node/v16.13.1/bin/node
npm: 8.1.2 - ~/.nvm/versions/node/v16.13.1/bin/npm
Browsers:
Chrome: 103.0.5060.134
Firefox: 102.0.1
Safari: 15.2
```

### Used Package Manager

npm

### Validations

- [X] Follow our [Code of Conduct](https://github.com/histoire-dev/histoire/blob/main/CODE_OF_CONDUCT.md)
- [X] Read the [Contributing Guidelines](https://github.com/histoire-dev/histoire/blob/main/CONTRIBUTING.md).
- [X] Read the [docs](https://histoire.dev/guide/).
- [X] Check that there isn't [already an issue](https://github.com/histoire-dev/histoire/issues) that reports the same bug to avoid creating a duplicate.
- [X] Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/histoire-dev/histoire/discussions).
- [X] The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.

Contributor guide

Open the contributing guide

Research direction

Run the linked StackBlitz reproduction and inspect src/BaseButton.story.vue alongside the Vue 3 Markdown docs guide. Reproduce an edit-and-save update, then trace the terminal error shown in the reproduction. Done means Markdown changes update the docs view without terminal errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.