Skip to content

Commit

Permalink
Remove React depedency (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
huijing authored Oct 13, 2023
1 parent 272a0d8 commit b96305f
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 16 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Inside this project, you'll see the following folders and files:
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ ├── overrides/
│ ├── layouts/
│ ├── pages/
│ ├── styles/
│ └── env.d.ts
├── astro.config.mjs
Expand All @@ -24,11 +25,13 @@ Inside this project, you'll see the following folders and files:

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.

Static assets, like favicons or images, can be placed in the `public/` directory.
Static assets, like favicons or images, can be placed in the `public/` directory. When referencing these assets in your markdown, you do not have to include `public/` in the file path, so an image would have a path like:

The key component for this site is the `Spec` component (found in the `components/` directory), which is how we pull the specification content directly from https://github.com/interledger/rfcs.
```md
![A lovely description of your beautiful image](/img/YOUR_BEAUTIFUL_IMAGE.png)
```

Overrides are done using a custom plugin (source: https://gist.github.com/giuseppelt/7f918a3ac02a011d76811ae472f8bf09) until the Starlight maintainers are able to get to https://github.com/withastro/starlight/issues/415. We are currently overriding the default Starlight header to match the main site header.
For more information about the way our documentation projects are set up, please refer to our [documentation style guide](https://interledger.tech/#docs-site-building).

## Local Development

Expand Down
3 changes: 0 additions & 3 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";

import react from "@astrojs/react";

// https://astro.build/config
export default defineConfig({
site: "https://interledger.org",
Expand Down Expand Up @@ -103,7 +101,6 @@ export default defineConfig({
},
],
}),
react(),
],
redirects: {
"/rfcs/0027-interledger-protocol-4/":
Expand Down
Binary file modified bun.lockb
Binary file not shown.
11 changes: 2 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,11 @@
"astro": "astro"
},
"dependencies": {
"@astrojs/react": "^3.0.3",
"@astrojs/starlight": "^0.11.0",
"@interledger/docs-design-system": "^0.0.14",
"@types/react": "^18.2.25",
"@types/react-dom": "^18.2.11",
"@interledger/docs-design-system": "^0.1.0",
"@types/showdown": "^2.0.2",
"astro": "^3.2.3",
"astro": "^3.3.0",
"node-html-parser": "^6.1.10",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-markdown": "^9.0.0",
"remark-gfm": "^4.0.0",
"sharp": "^0.32.6",
"showdown": "^2.1.0"
}
Expand Down

0 comments on commit b96305f

Please sign in to comment.