Skip to content

Commit

Permalink
Merge pull request #6 from thoth-tech/main
Browse files Browse the repository at this point in the history
Adding T1-2024 Thoth Tech contributions
  • Loading branch information
macite authored Jun 26, 2024
2 parents 6803cdb + e9f61c4 commit fa013aa
Show file tree
Hide file tree
Showing 1,207 changed files with 8,669 additions and 689 deletions.
17 changes: 17 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
FROM mcr.microsoft.com/devcontainers/javascript-node:0-20

# Install OpenJDK-8
RUN apt-get update && \
apt-get install -y openjdk-11-jdk && \
apt-get install -y ant && \
apt-get clean;

# Fix certificate issues
RUN apt-get update && \
apt-get install ca-certificates-java && \
apt-get clean && \
update-ca-certificates -f;

RUN ln -s `readlink -f /usr/bin/java | sed "s:bin/java::"` /usr/local/java

ENV JAVA_HOME /usr/local/java
32 changes: 32 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +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"
}
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
dist/
# generated types
.astro/
.vscode/

# dependencies
node_modules/
Expand Down Expand Up @@ -46,6 +45,7 @@ src/content/docs/api/Timers.mdx
src/content/docs/api/Types.mdx
src/content/docs/api/Utilities.mdx
src/content/docs/api/Windows.mdx
src/content/docs/api/Raspberry.mdx
src/content/docs/guides/Animations/index.mdx
src/content/docs/guides/Audio/index.mdx
src/content/docs/guides/Camera/index.mdx
Expand All @@ -58,3 +58,4 @@ src/content/docs/guides/Others/index.mdx
src/content/docs/guides/Sprites/index.mdx
src/content/docs/guides/Starter/index.mdx
src/content/docs/guides/Utilities/index.mdx
src/content/docs/api/Raspberry.mdx
4 changes: 4 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"MD033": false,
"MD013": false
}
3 changes: 0 additions & 3 deletions .vs/ProjectSettings.json

This file was deleted.

4 changes: 4 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"files.associations": {
"*.mdx": "markdown"
}
}
22 changes: 22 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
{
"version": "2.0.0",
"tasks": [
{
"label": "Serve splashkit.io Website",
"type": "shell",
"command": "npm install && ./node_modules/.bin/astro dev",
"group": "build",
"presentation": {
"group": "buildGroup",
"reveal": "always",
"panel": "new",
"echo": false
},
"runOptions": {
"runOn": "folderOpen" // This starts both tasks when the container is started
},
}
]
}
43 changes: 29 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,49 @@
# SplashKit SDK - Starlight Framework

## Introduction
Welcome to the official documentation for the SplashKit SDK on the Starlight framework! This readme markdown script will guide you through the installation process and provide an overview of the features and functionalities of the SDK.

Welcome to the official documentation for the SplashKit SDK on the Starlight framework! This README markdown script will guide you through the installation process and provide an overview of the features and functionalities of the SDK.

## Deployment Status
- [Production](https://master--splashkit.netlify.app/) - [![Netlify Status](https://api.netlify.com/api/v1/badges/29627b16-8f40-4b42-8ae8-1912895f5305/deploy-status?branch=master)](https://app.netlify.com/sites/splashkit/deploys) ![Github Pages](https://github.com/splashkit/splashkit.io-starlight/actions/workflows/astro.yml/badge.svg?branch=master)
- [Development](https://development--splashkit.netlify.app/) - [![Netlify Status](https://api.netlify.com/api/v1/badges/29627b16-8f40-4b42-8ae8-1912895f5305/deploy-status?branch=development)](https://app.netlify.com/sites/splashkit/deploys) ![Github Pages](https://github.com/splashkit/splashkit.io-starlight/actions/workflows/astro.yml/badge.svg?branch=production)

[Thoth Tech's 'splashkit.io' Site](https://splashkit-io.netlify.app/) - [![Netlify Status](https://api.netlify.com/api/v1/badges/e8def4e6-f39d-458a-8ca9-556d61ce1fbd/deploy-status)](https://app.netlify.com/sites/splashkit-io/deploys)

<!-- - [Production](https://master--splashkit.netlify.app/) - [![Netlify Status](https://api.netlify.com/api/v1/badges/29627b16-8f40-4b42-8ae8-1912895f5305/deploy-status?branch=master)](https://app.netlify.com/sites/splashkit/deploys) ![Github Pages](https://github.com/splashkit/splashkit.io-starlight/actions/workflows/astro.yml/badge.svg?branch=master)
- [Development](https://development--splashkit.netlify.app/) - [![Netlify Status](https://api.netlify.com/api/v1/badges/29627b16-8f40-4b42-8ae8-1912895f5305/deploy-status?branch=development)](https://app.netlify.com/sites/splashkit/deploys) ![Github Pages](https://github.com/splashkit/splashkit.io-starlight/actions/workflows/astro.yml/badge.svg?branch=production) -->

## Installation
1. Clone/Fork this repository.
1. Install the necessary dependencies. Make sure you have the following installed:
```

1. Install and open Docker app.
2. Fork then clone this repository.
3. Reopen cloned repository in container (pop-up may appear in VS Code)

If needed:

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

```bash
npm install
```

## 🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:
```
```text
.
├── public/
└── src/
├── assets/
├── components/
├── content/
│ ├── docs/
│ ├── components/
│ ├── guides/
│ ├── installation/
│ └── troubleshoot/
│ │ ├── api/
│ │ ├── guides/
│ │ ├── installation/
│ │ └── troubleshoot/
├── fonts/
├── styles/
├── config.ts
<!-- ├── config.ts -->
└── env.d.ts
├── astro.config.mjs
├── package.json
Expand All @@ -39,7 +54,7 @@ Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory.
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in the `public/` directory.
Static assets, like favicons and gifs, can be placed in the `public/` directory.
## 🧞 Commands
Expand All @@ -56,5 +71,5 @@ All commands are run from the root of the project, from a terminal:
| `npm run generate-mdx` | Generate MDX file *(for functions)* from JSON data in `test` folder |
## Contributing
We welcome contributions from the community to enhance the SplashKit SDK on the Starlight framework. If you would like to contribute, please follow the guidelines outlined in the CONTRIBUTING.md file.
We welcome contributions from the community to enhance the SplashKit SDK on the Starlight framework. If you would like to contribute, please follow the guidelines outlined in the CONTRIBUTING.md file.
13 changes: 8 additions & 5 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
// Author: Aditya Parmar (XQuestCode)
// Contact: [email protected]
import { defineConfig, squooshImageService } from "astro/config";
import starlight from "@astrojs/starlight";
import solidJs from "@astrojs/solid-js";

import react from "@astrojs/react";

import starlightLinksValidator from 'starlight-links-validator';
import sitemap from "@astrojs/sitemap";

// https://astro.build/config
Expand All @@ -21,6 +18,12 @@ export default defineConfig({
components: {
Sidebar: './src/components/Sidebar.astro'
},

plugins: [
starlightLinksValidator({
errorOnRelativeLinks: true,
}),
],
expressiveCode: {
// theme: ["github-dark", "github-light"],
// frames: {
Expand All @@ -30,7 +33,7 @@ export default defineConfig({
useDarkModeMediaQuery: true,
},
customCss: [

"/src/styles/custom.css",
"/src/styles/background.css",
"/src/styles/cards.css",
Expand Down
Loading

0 comments on commit fa013aa

Please sign in to comment.