Skip to content

Commit 41d62e4

Browse files
committed
update readme
1 parent 3345edd commit 41d62e4

File tree

2 files changed

+11
-51
lines changed

2 files changed

+11
-51
lines changed

README.md

Lines changed: 3 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,5 @@
1-
# Starlight Starter Kit: Basics
1+
# JS Engine Docs
22

3-
```
4-
npm create astro@latest -- --template starlight
5-
```
3+
Plugin: [JS Engine](https://github.com/mProjectsCode/obsidian-js-engine-plugin)
64

7-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
8-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
9-
10-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
11-
12-
## 🚀 Project Structure
13-
14-
Inside of your Astro + Starlight project, you'll see the following folders and files:
15-
16-
```
17-
.
18-
├── public/
19-
├── src/
20-
│ ├── assets/
21-
│ ├── content/
22-
│ │ ├── docs/
23-
│ │ └── config.ts
24-
│ └── env.d.ts
25-
├── astro.config.mjs
26-
├── package.json
27-
└── tsconfig.json
28-
```
29-
30-
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
31-
32-
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
33-
34-
Static assets, like favicons, can be placed in the `public/` directory.
35-
36-
## 🧞 Commands
37-
38-
All commands are run from the root of the project, from a terminal:
39-
40-
| Command | Action |
41-
| :------------------------ | :----------------------------------------------- |
42-
| `npm install` | Installs dependencies |
43-
| `npm run dev` | Starts local dev server at `localhost:4321` |
44-
| `npm run build` | Build your production site to `./dist/` |
45-
| `npm run preview` | Preview your build locally, before deploying |
46-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
47-
| `npm run astro -- --help` | Get help using the Astro CLI |
48-
49-
## 👀 Want to learn more?
50-
51-
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
5+
Docs Link: [JS Engine Docs](https://www.moritzjung.dev/obsidian-js-engine-plugin-docs/)

src/content/docs/index.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,13 @@ If you have an idea, feel free to open a feature request under the [issues tab o
2727

2828
## Check out my Other Work
2929

30-
Here is a list of my other plugins for Obsidian.
30+
Check out [my website](https://www.moritzjung.dev).
31+
32+
Here is a list of my Obsidian related projects.
3133

3234
- [Meta Bind Plugin](https://github.com/mProjectsCode/obsidian-meta-bind-plugin)
33-
- [Media DB Plugin](https://github.com/mProjectsCode/obsidian-media-db-plugin)
35+
- [JS Engine Plugin](https://github.com/mProjectsCode/obsidian-js-engine-plugin) (You are here)
36+
- [Media DB Plugin](https://github.com/mProjectsCode/obsidian-media-db-plugin)
37+
- [Lemons Theme](https://github.com/mProjectsCode/obsidian-lemons-theme)
38+
- [Obsidian Stats](https://www.moritzjung.dev/obsidian-stats)
39+
- [Obsidian Collection](https://www.moritzjung.dev/obsidian-collection)

0 commit comments

Comments
 (0)