Skip to content

cihantas/applib-docs

Repository files navigation

AppLib Documentation

Documentation site for AppLib built with Next.js and MDX.

Features

  • GitHub Integration: Automatically fetches docs from cihantas/applib GitHub repository
  • Local Fallback: Falls back to local files if GitHub is unavailable
  • Dynamic Routing: Handles nested documentation structure
  • Search: Integrated Pagefind search functionality
  • Nested Navigation: Collapsible sidebar with nested doc structure

Getting Started

Development

# Copy docs from local applib directory (optional, GitHub is primary source)
npm run copy-docs

# Start development server
npm run dev

# Or copy docs and start in one command
npm run dev:with-docs

Open http://localhost:3000/docs to view the documentation.

Building

# Copy docs and build
npm run build:with-docs

# Or build without copying (will use GitHub)
npm run build

How It Works

  1. Content Source: The docs system fetches content from GitHub (cihantas/applib repo) first
  2. Fallback: If GitHub is unavailable, it falls back to local files in content/docs/
  3. Navigation: The sidebar navigation is built from local files (run npm run copy-docs to update)
  4. Caching: GitHub content is cached for 1 hour to improve performance

Configuration

You can override the GitHub repository and branch using environment variables:

GITHUB_REPO=cihantas/applib
GITHUB_BRANCH=main

Scripts

  • npm run copy-docs - Copy markdown files from ../applib/docs to content/docs
  • npm run dev - Start development server
  • npm run dev:with-docs - Copy docs and start dev server
  • npm run build - Build for production
  • npm run build:with-docs - Copy docs and build

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published