Skip to content

Commit 4c008e5

Browse files
committed
Add docs link
1 parent d40a153 commit 4c008e5

File tree

1 file changed

+1
-34
lines changed

1 file changed

+1
-34
lines changed

readme.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,7 @@
33

44
Build first-class code walkthroughs for the web. Whether you are writing blog posts, documentation, tutorials, coding videos, or any type of technical content, Code Hike helps you create a superior code reading experience.
55

6-
**There isn't a stable version yet**, but there's a preview version for people who want to try it out and [give feedback](https://github.com/code-hike/codehike/discussions). You can use it in any project that has MDX v2 configured. Or you can clone [this starter project](https://github.com/pomber/code-hike-sample).
7-
8-
There are no docs yet, but you can [explore the demos](https://codehike.org/#demos) for an overview of all the features and how to use them.
9-
10-
## How to set up Code Hike
11-
12-
1. First you need MDX v2 (or [xdm](https://github.com/wooorm/xdm/)). See [MDX v2 docs](https://mdxjs.com/docs/getting-started/) on how to set it up.
13-
2. Install Code Hike remark plugin with `yarn add @code-hike/mdx@next`
14-
3. Add the remark plugin to the MDX loader options. This depends on the bundler or site generator you are using. It usually looks something like this:
15-
16-
```js
17-
const { remarkCodeHike } = require("@code-hike/mdx");
18-
const theme = require("shiki/themes/monokai.json"); // any theme from shiki
19-
20-
// ...
21-
// somewhere on your bundler configuration:
22-
// {
23-
// loader: "@mdx-js/loader",
24-
// options: {
25-
remarkPlugins: [[remarkCodeHike, { theme }]],
26-
// },
27-
// },
28-
// ...
29-
```
30-
31-
4. Add Code Hike's CSS. Also depends on your stack. Usually you can _just_ import it:
32-
33-
```js
34-
import "@code-hike/mdx/dist/index.css";
35-
```
36-
37-
5. Create an mdx file and copy the code from any of the [demos](https://codehike.org/#demos) to see if it works
38-
39-
Here is a [minimal Next.js example](https://github.com/pomber/code-hike-sample).
6+
**Docs: https://codehike.org/docs**
407

418
## License
429

0 commit comments

Comments
 (0)