Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/javascript-node
{
"name": "splashkit.io",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
// "image": "mcr.microsoft.com/devcontainers/javascript-node:0-20",
"dockerFile": "Dockerfile",
"customizations": {
"vscode": {
"extensions": [
"dbaeumer.vscode-eslint",
"yzhang.markdown-all-in-one",
"DavidAnson.vscode-markdownlint",
"astro-build.astro-vscode",
"ms-vsliveshare.vsliveshare",
// "tomoki1207.pdf",
"eamodio.gitlens"
// "valentjn.vscode-ltex"
]
}
}
// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "yarn install",
// Configure tool-specific properties.
// "customizations": {},
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
"name": "splashkit.io",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
// "image": "mcr.microsoft.com/devcontainers/javascript-node:0-20",
"dockerFile": "Dockerfile",
"customizations": {
"vscode": {
"extensions": [
"dbaeumer.vscode-eslint",
"yzhang.markdown-all-in-one",
"DavidAnson.vscode-markdownlint",
"astro-build.astro-vscode",
"ms-vsliveshare.vsliveshare",
// "tomoki1207.pdf",
"eamodio.gitlens"
// "valentjn.vscode-ltex"
]
}
}
// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "yarn install",
// Configure tool-specific properties.
// "customizations": {},
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
3 changes: 3 additions & 0 deletions .env.local
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
DOCSEARCH_API_ID=local
DOCSEARCH_API_SEARCH_KEY=local
DOCSEARCH_INDEX_NAME=local
2 changes: 1 addition & 1 deletion .github/workflows/astro.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Deploy to GitHub Pages

on:
push:
branches: [ master ]
branches: [master]
workflow_dispatch:

permissions:
Expand Down
6 changes: 3 additions & 3 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"MD033": false,
"MD013": false
}
"MD033": false,
"MD013": false
}
36 changes: 13 additions & 23 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,69 +3,59 @@
Follow these steps to contribute to the SplashKit website repository:

1. **Fork the Repository:**

- Visit the SplashKit repository on GitHub.
- Click on the "Fork" button in the top-right corner of the page. This will create a copy of the repository under your GitHub account.

2. **Clone Your Fork:**

- Open your terminal or Git client.
- Clone your forked repository to your local machine using the following command:

```shell
git clone https://github.com/YOUR_USERNAME/splashkit.git
```
```shell
git clone https://github.com/YOUR_USERNAME/splashkit.git
```

3. **Checkout new branch:**

- Open your terminal or Git client.
- Create a new branch on your forked repository using the following command (replace `<new-branch>` with your chosen name):

```shell
git checkout -b <new-branch>
```
```shell
git checkout -b <new-branch>
```

4. **Make Your Changes:**

- Navigate to the project directory on your local machine.
- Make your respective changes, ensuring high-quality contributions.

5. **Commit Your Changes:**

- After making changes, commit them with meaningful commit messages.

```shell
git add .
git commit -m "Your descriptive commit message"
```
```shell
git add .
git commit -m "Your descriptive commit message"
```

6. **Push Changes to Your Fork:**

- Push your changes to your forked repository on GitHub.

```shell
git push origin master
```
```shell
git push origin master
```

7. **Create a Pull Request (PR):**

- Visit your forked repository on GitHub.
- Click on the "New Pull Request" button.
- Ensure the base and head repositories have been set correctly.
- Click on "Create Pull Request."

8. **Wait for Review:**

- The maintainers will review your PR. Be patient, and be ready to respond to any feedback or comments.
- If changes are requested, make the necessary updates and push them to your forked repository.

9. **Follow Up to Comments:**

- Engage with any comments or questions from the maintainers.
- If additional changes are needed, repeat steps 4-7.

10. **PR Approval/Rejection:**

- Once your changes are approved, the maintainers will merge your PR into the main repository.
- If your changes are rejected, understand the feedback and consider making improvements before submitting another PR.

Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Welcome to the official documentation website for the SplashKit SDK, using the S
![Forks](https://img.shields.io/github/forks/splashkit/splashkit.io-starlight?label=Forks&color=F5A623)
![Stars](https://img.shields.io/github/stars/splashkit/splashkit.io-starlight?label=Stars&color=F5A623)

[thoth-tech/splashkit.io-starlight](https://github.com/thoth-tech/splashkit.io-starlight) *
[thoth-tech/splashkit.io-starlight](https://github.com/thoth-tech/splashkit.io-starlight) \*

[![GitHub contributors](https://img.shields.io/github/contributors/thoth-tech/splashkit.io-starlight?label=Contributors&color=F5A623)](https://github.com/thoth-tech/splashkit.io-starlight/graphs/contributors)
[![GitHub issues](https://img.shields.io/github/issues/thoth-tech/splashkit.io-starlight?label=Issues&color=F5A623)](https://github.com/thoth-tech/splashkit.io-starlight/issues)
Expand All @@ -37,9 +37,9 @@ If needed:

- Install the necessary dependencies. Make sure you have the following installed:

```shell
npm install
```
```shell
npm install
```

## 🚀 Project Structure

Expand Down Expand Up @@ -80,18 +80,18 @@ Inside of your Astro + Starlight project, you'll see the following folders and f

All commands are run from the root of the project, from a terminal:

| Command | Action |
| :-------------------------------------- | :---------------------------------------------------------------------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4322` |
| `npm run build` | Builds your production site to `./dist/` |
| `npm run preview` | Previews your build locally, before deploying |
| `npm run astro ...` | Runs CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Gets help using the Astro CLI |
| `npm run generate-mdx` | Generates an MDX file *(for functions)* from JSON data in the `test` folder |
| `npm run generate-usage-examples-pages` | Runs the script to generate usage example pages from the `./scripts/usage-example-page-generation.cjs` file |
| Command | Action |
| :---------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4322` |
| `npm run build` | Builds your production site to `./dist/` |
| `npm run preview` | Previews your build locally, before deploying |
| `npm run astro ...` | Runs CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Gets help using the Astro CLI |
| `npm run generate-mdx` | Generates an MDX file _(for functions)_ from JSON data in the `test` folder |
| `npm run generate-usage-examples-pages` | Runs the script to generate usage example pages from the `./scripts/usage-example-page-generation.cjs` file |
| `npm run generate-usage-examples-pages write_line-1-simple` | Runs the script to generate usage example pages from the `./scripts/usage-example-page-generation.cjs` file and prints the testing output for the `write_line-1-simple` example |
| `npm run check-links` | Sets `CHECK_LINKS=true`, runs `npm run build`, then resets `CHECK_LINKS=false` |
| `npm run check-links` | Sets `CHECK_LINKS=true`, runs `npm run build`, then resets `CHECK_LINKS=false` |

## Contributing

Expand Down
Loading