Git Pages Docs

Getting Started

Configure repository from zero

Getting Started

This guide configures your repository from zero to running docs.

Prerequisites

  • Node.js 20+
  • npm 10+

Install and generate

  1. Install package:
    • npm install gitpagedocs
  2. Generate docs config and versions:
    • npx gitpagedocs
  3. Optional: generate local layouts/templates:
    • npx gitpagedocs --layoutconfig

Local run

  1. Development:
    • npm run dev
  2. Production locally:
    • npm run build
    • npm start

CLI behavior

npx gitpagedocs generates only artifacts in gitpagedocs/:

  • JSON + markdown docs assets
  • No index.html
  • No index.js
  • No install command execution

Repository search mode

Local repository search is controlled by:

  • GITPAGEDOCS_REPOSITORY_SEARCH=true
  • GITPAGEDOCS_REPOSITORY_SEARCH=false

On GitHub Pages builds (GITHUB_ACTIONS=true), repository-search home is enabled.

Version: 1.1.0

Source code

View project source code

Interactive vs non-interactive modes | Copilot CLI for beginners

Want to know the fastest way to prompt GitHub Copilot from your terminal? In this beginner tutorial, we explore the two main modes of the Copilot CLI. Discover how to use the interactive mode to have GitHub Copilot run your project locally or use the non-interactive mode with the -p flag for quick summaries without leaving your shell context.