Skip to content

Commit 7d49a97

Browse files
committed
i need to switch to wsl
0 parents  commit 7d49a97

File tree

13 files changed

+8393
-0
lines changed

13 files changed

+8393
-0
lines changed

.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
5+
6+
# dependencies
7+
node_modules/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS-specific files
21+
.DS_Store
22+
23+
.vscode/
24+
.idea/

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "obsidian-js-engine-plugin"]
2+
path = obsidian-js-engine-plugin
3+
url = https://github.com/mProjectsCode/obsidian-js-engine-plugin

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Starlight Starter Kit: Basics
2+
3+
```
4+
npm create astro@latest -- --template starlight
5+
```
6+
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).

astro.config.mjs

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import { defineConfig } from 'astro/config';
2+
import starlight from '@astrojs/starlight';
3+
import { generateTypeDoc } from 'starlight-typedoc';
4+
5+
const typeDocSidebarGroup = await generateTypeDoc({
6+
entryPoints: ['obsidian-js-engine-plugin/jsEngine/api/*'],
7+
typeDoc: {
8+
entryPointStrategy: 'expand',
9+
},
10+
tsconfig: 'obsidian-js-engine-plugin/tsconfig.json',
11+
});
12+
13+
// https://astro.build/config
14+
export default defineConfig({
15+
integrations: [
16+
starlight({
17+
title: 'JS Engine Docs',
18+
social: {
19+
github: 'https://github.com/mProjectsCode/obsidian-js-engine-plugin',
20+
},
21+
sidebar: [
22+
{
23+
label: 'Guides',
24+
items: [
25+
// Each item here is one entry in the navigation menu.
26+
{ label: 'Example Guide', link: '/guides/example/' },
27+
],
28+
},
29+
typeDocSidebarGroup,
30+
],
31+
}),
32+
],
33+
});

obsidian-js-engine-plugin

0 commit comments

Comments
 (0)