Skip to content

nxtkb/nxtkb.github.io

Repository files navigation

NXTKB Official Website

Built with Astro GitHub Pages License: MIT

Introduction

This repository contains the official website for NXTKB. The site is built with Astro, uses custom product pages for the marketing surface, and uses Starlight for documentation.

Features

  • Product-first design: Custom Astro pages for the homepage and product showcase
  • Documentation: Starlight-powered user guides and setup instructions
  • Multi-language Support: English root pages and Chinese pages under /zh/
  • Fast Loading: Static Astro output deployed to GitHub Pages
  • Search Functionality: Starlight documentation search

Prerequisites

  • Node.js 24
  • npm

Setup Instructions

1. Install dependencies

npm install

2. Run the site locally

npm run dev

The site will be available at http://localhost:4321

Development

Adding Content

  • Product and landing pages live in /src/pages/ and /src/components/
  • Documentation lives in /src/content/docs/docs/
  • Chinese documentation lives in /src/content/docs/zh/docs/
  • Static files live in /public/
npm run dev

Building for Production

npm run build

Technologies Used

Deployment

The site is automatically deployed to GitHub Pages using GitHub Actions when changes are pushed to the main branch. The deployment workflow installs Node.js dependencies, runs the Astro build, uploads dist/, and deploys via GitHub Pages.

Contributing

We welcome contributions from the community! If you'd like to help improve the website:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/amazing-features)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add amazing features')
  5. Push to the branch (git push origin feature/amazing-features)
  6. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For support with the NXTKB product, see the documentation or product pages.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors