Giter Club home page Giter Club logo

splashkit.io-starlight's Introduction

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.

Deployment Status

Thoth Tech's 'splashkit.io' Site - Netlify Status

Installation

  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:

    npm install

๐Ÿš€ Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

.
โ”œโ”€โ”€ public/
โ””โ”€โ”€ src/
    โ”œโ”€โ”€ assets/
    โ”œโ”€โ”€ components/
    โ”œโ”€โ”€ content/
    โ”‚   โ”œโ”€โ”€ docs/
    โ”‚   โ”‚   โ”œโ”€โ”€ api/
    โ”‚   โ”‚   โ”œโ”€โ”€ guides/
    โ”‚   โ”‚   โ”œโ”€โ”€ installation/
    โ”‚   โ”‚   โ””โ”€โ”€ troubleshoot/
    โ”œโ”€โ”€ fonts/
    โ”œโ”€โ”€ styles/
    <!-- โ”œโ”€โ”€ config.ts -->
    โ””โ”€โ”€ env.d.ts
โ”œโ”€โ”€ astro.config.mjs
โ”œโ”€โ”€ package.json
โ””โ”€โ”€ tsconfig.json

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.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons and gifs, can be placed in the public/ directory.

๐Ÿงž Commands

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:3000
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI
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.

splashkit.io-starlight's People

Contributors

xquestcode avatar omckeon avatar macite avatar derdiedasdeakin avatar charlottepierce avatar jakerenzella avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.