https://github.com/yuleicul/obsidian-mdx
Preview MDX in Obsidian, with support for Code Hike
https://github.com/yuleicul/obsidian-mdx
codehike mdx obsidian
Last synced: about 1 month ago
JSON representation
Preview MDX in Obsidian, with support for Code Hike
- Host: GitHub
- URL: https://github.com/yuleicul/obsidian-mdx
- Owner: yuleicul
- License: mit
- Created: 2023-06-11T13:18:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-27T10:14:14.000Z (over 1 year ago)
- Last Synced: 2025-03-19T09:21:11.491Z (about 1 month ago)
- Topics: codehike, mdx, obsidian
- Language: TypeScript
- Homepage: https://obsidian.md/plugins?search=yulei%20chen
- Size: 38.1 KB
- Stars: 34
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Obsidian MDX
Preview [MDX](https://github.com/mdx-js/mdx/) in Obsidian, with support for [Code Hike](https://github.com/code-hike/codehike).
## Installation
https://obsidian.md/plugins?search=yulei%20chen
## Getting Started
### Usage
1. Write MDX syntax in Obsidian (and it is recommended to have open source mode turned on).
2. Press `ctrl/cmd + p` to open the Command Palette.
3. Type `mdx: preview` in the Command Palette and press `Enter`.
### Support for Codehike
This plugin also provides added support for Code Hike.
If you want to try it out, you can copy [this example](https://github.com/code-hike/codehike/blob/next/examples/vite/src/hello.mdx) to Obsidian.## Contributing
If you would like to contribute to this project, please open an issue or submit a pull request.
## License
This project is licensed under the MIT License - see the LICENSE file for details.