Skip to content

Commit

Permalink
Fix broken optionals and also readme (#863)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ekwuno authored Sep 18, 2024
1 parent b8364ea commit 5cb3edb
Show file tree
Hide file tree
Showing 41 changed files with 481 additions and 175 deletions.
37 changes: 15 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,13 @@
<br>

<p align="center">
<a href="https://surrealdb.com#gh-dark-mode-only" target="_blank">
<img width="300" src="/img/white/logo.svg" alt="SurrealDB Logo">
</a>
<a href="https://surrealdb.com#gh-light-mode-only" target="_blank">
<img width="300" src="/img/black/logo.svg" alt="SurrealDB Logo">
<img width="300" src="src/assets/img/white/logo.svg" alt="SurrealDB Logo">
</a>
</p>

<h3 align="center">
<a href="https://surrealdb.com#gh-dark-mode-only" target="_blank">
<img src="/img/white/text.svg" height="15" alt="SurrealDB">
</a>
<a href="https://surrealdb.com#gh-light-mode-only" target="_blank">
<img src="/img/black/text.svg" height="15" alt="SurrealDB">
<img src="src/assets/img/white/text.svg" height="15" alt="SurrealDB">
</a>
is the ultimate cloud <br> database for tomorrow's applications
</h3>
Expand All @@ -23,7 +16,7 @@

<br>

<p align="center">The documentation for <a href="https://github.com/surrealdb/surrealdb" target="_blank">SurrealDB</a>, built using <a href="https://docusaurus.io/" target="_blank">Docusaurus</a>.</p>
<p align="center">The documentation for <a href="https://github.com/surrealdb/surrealdb" target="_blank">SurrealDB</a>, built using <a href="https://astro.build/" target="_blank">Astro</a>.</p>

<p align="center">If you want to contribute, then please read the <a href="https://github.com/surrealdb/awesome-surreal/blob/main/CONTRIBUTING.md" target="_blank">contributing guidelines</a>.</p>

Expand All @@ -42,21 +35,21 @@
</p>

<p align="center">
<a href="https://surrealdb.com/blog"><img height="25" src="/img/social/blog.svg" alt="Blog"></a>
<a href="https://surrealdb.com/blog"><img height="25" src="src/assets/img/social/blog.svg" alt="Blog"></a>
&nbsp;
<a href="https://github.com/surrealdb/surrealdb"><img height="25" src="/img/social/github.svg" alt="Github "></a>
<a href="https://github.com/surrealdb/surrealdb"><img height="25" src="src/assets/img/social/github.svg" alt="Github "></a>
&nbsp;
<a href="https://www.linkedin.com/company/surrealdb/"><img height="25" src="/img/social/linkedin.svg" alt="LinkedIn"></a>
<a href="https://www.linkedin.com/company/surrealdb/"><img height="25" src="src/assets/img/social/linkedin.svg" alt="LinkedIn"></a>
&nbsp;
<a href="https://twitter.com/surrealdb"><img height="25" src="/img/social/twitter.svg" alt="Twitter"></a>
<a href="https://twitter.com/surrealdb"><img height="25" src="src/assets/img/social/twitter.svg" alt="Twitter"></a>
&nbsp;
<a href="https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w"><img height="25" src="/img/social/youtube.svg" alt="Youtube"></a>
<a href="https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w"><img height="25" src="src/assets/img/social/youtube.svg" alt="Youtube"></a>
&nbsp;
<a href="https://dev.to/surrealdb"><img height="25" src="/img/social/dev.svg" alt="Dev"></a>
<a href="https://dev.to/surrealdb"><img height="25" src="src/assets/img/social/dev.svg" alt="Dev"></a>
&nbsp;
<a href="https://surrealdb.com/discord"><img height="25" src="/img/social/discord.svg" alt="Discord"></a>
<a href="https://surrealdb.com/discord"><img height="25" src="src/assets/img/social/discord.svg" alt="Discord"></a>
&nbsp;
<a href="https://stackoverflow.com/questions/tagged/surrealdb"><img height="25" src="/img/social/stack-overflow.svg" alt="StackOverflow"></a>
<a href="https://stackoverflow.com/questions/tagged/surrealdb"><img height="25" src="src/assets/img/social/stack-overflow.svg" alt="StackOverflow"></a>
</p>

<br>
Expand All @@ -77,22 +70,22 @@ We have a list of [good first issues](https://github.com/surrealdb/docs.surreald

To get started with contributing to the SurrealDB documentation, first install the required packages using the following command.

```
$ pnpm install
```bash
bun i
```

### Development

The following command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

```
$ pnpm start
bun dev
```

### Building

The following command builds and generates static content into the `build` directory, and can then be served using any static contents hosting service.

```
$ pnpm build
bun build
```
53 changes: 53 additions & 0 deletions src/assets/img/black/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 41 additions & 0 deletions src/assets/img/black/text.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions src/assets/img/social/blog.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions src/assets/img/social/dev.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions src/assets/img/social/discord.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions src/assets/img/social/github.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions src/assets/img/social/linkedin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions src/assets/img/social/stack-overflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5cb3edb

Please sign in to comment.