|
1 | | -# Starlight Starter Kit: Basics |
| 1 | +# JS Engine Docs |
2 | 2 |
|
3 | | -``` |
4 | | -npm create astro@latest -- --template starlight |
5 | | -``` |
| 3 | +Plugin: [JS Engine](https://github.com/mProjectsCode/obsidian-js-engine-plugin) |
6 | 4 |
|
7 | | -[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics) |
8 | | -[](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/) |
0 commit comments