Skip to content

DigitalCoreHub/tinypine-docs

Repository files navigation

TinyPine.js Documentation

🌲 Official documentation website for TinyPine.js - a minimal, reactive JavaScript framework.

πŸš€ Quick Start

Development

# Install dependencies
npm install

# Start dev server
npm run dev

Build

# Build for production (default: /tinypine-docs/)
npm run build

# Build with custom base URL (e.g., for custom domain)
BASE_URL=/ npm run build

# Preview production build
npm run preview

Deploy to GitHub Pages

# Deploy manually
npm run deploy

Or push to the main branch and GitHub Actions will automatically deploy.

βš™οΈ Configuration

Base URL

The project uses / (root) as the base URL by default. If you're deploying to:

  • GitHub Pages subdirectory (e.g., username.github.io/repo-name/): Set BASE_URL environment variable

    BASE_URL=/repo-name/ npm run build
  • Custom domain or root deployment (default): No need to change anything

    npm run build

GitHub Pages Setup

  1. Go to your repository Settings > Pages
  2. Under "Build and deployment", select Source: GitHub Actions
  3. Push to main branch - deployment will start automatically
  4. Your site will be available at https://username.github.io/repo-name/

πŸ“¦ Tech Stack

🌐 Live Site

Visit the documentation at: https://digitalcorehub.github.io/tinypine-docs/

πŸ“ License

MIT Β© DigitalCoreHub

About

🌲 Official documentation site for TinyPine.js β€” minimal reactive UI framework.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •