Skip to content

KunalPareek21/handbook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Handbook

A modern documentation and team handbook WordPress theme built for remote-first companies, open source projects, agencies, and organisations publishing culture, onboarding, process, and operational documentation publicly.

Theme URI: https://kunalpareek.in/handbook Author: Kunal Pareek — https://kunalpareek.in GitHub: https://github.com/KunalPareek21/handbook License: GPL v2 or later


What Handbook Is

Handbook is a production-grade WordPress Full Site Editing theme purpose-built for:

  • Remote-first company handbooks
  • Public internal documentation
  • Onboarding guides
  • Operational manuals and processes
  • Policy systems
  • Culture documentation
  • Open source governance
  • Engineering team documentation
  • Distributed team communication

It is designed by someone who understands how serious organisations document operations, communicate asynchronously, and build sustainable knowledge systems.

What Handbook Is Not

  • A startup landing page theme
  • A documentation skin over a blog
  • A generic knowledge base template
  • A SaaS marketing aesthetic
  • A portfolio theme

Features

Architecture

  • Full Site Editing (FSE) with block templates and template parts
  • theme.json v3 with comprehensive design tokens
  • Block patterns for handbooks, onboarding, policies, FAQs, and more
  • 4 style variations: Light, Dark, High Contrast, Minimal
  • Custom page templates: Handbook, Policy, Onboarding, Glossary, Full Width

Design

  • Typography-first layout with Inter, Source Serif 4, and JetBrains Mono
  • 760px content width optimised for long-form reading
  • Calm, professional documentation aesthetic
  • Dark mode support via prefers-color-scheme
  • Print-ready layouts with optimised print stylesheet

Navigation

  • Sticky sidebar documentation navigation
  • Deeply nested collapsible navigation sections
  • Auto-generated table of contents from headings
  • Breadcrumb navigation with schema markup
  • Keyboard-accessible search overlay (/ shortcut)

Accessibility

  • WCAG 2.1 AA compliant
  • Full keyboard navigation
  • Skip links
  • Visible focus states
  • prefers-reduced-motion respected
  • Semantic HTML5 and ARIA landmarks
  • Screen reader support

Performance

  • Self-hosted variable fonts (no external CDN)
  • Deferred JavaScript loading
  • Minimal CSS and JS footprint
  • No jQuery dependency
  • No CSS frameworks
  • Optimised for Lighthouse 95+

SEO

  • JSON-LD structured data (Article, WebPage, BreadcrumbList, SearchAction)
  • Open Graph and Twitter Card ready structure
  • Semantic heading hierarchy

Requirements

  • WordPress 6.3 or higher
  • PHP 8.0 or higher

Installation

From WordPress.org

  1. Go to Appearance > Themes > Add New.
  2. Search for "Handbook".
  3. Click Install, then Activate.

Manual

  1. Download the latest release from GitHub.
  2. Go to Appearance > Themes > Add New > Upload Theme.
  3. Upload the ZIP and activate.

Quick Start

  1. Activate the theme.
  2. Go to Settings > Reading and set a static front page.
  3. Create your page hierarchy (see docs/setup.md).
  4. Create navigation menus in Appearance > Editor > Navigation.
  5. Assign page templates (Handbook, Policy, Onboarding, etc.) to your pages.
  6. Start writing documentation.

Folder Structure

handbook/
├── assets/
│   ├── css/          # Stylesheets (style, editor, print, docs)
│   ├── js/           # JavaScript (navigation, TOC, search, collapsible nav)
│   ├── fonts/        # Self-hosted variable fonts
│   └── images/       # Theme images
├── docs/             # Theme documentation
├── inc/              # PHP includes
│   ├── setup/        # Theme setup, enqueue, block patterns
│   ├── navigation/   # Breadcrumbs, walker
│   ├── accessibility/# Skip links, focus management
│   ├── search/       # AJAX search functions
│   ├── schema/       # JSON-LD structured data
│   └── performance/  # Performance optimisations
├── parts/            # Template parts (header, footer, sidebar, TOC, etc.)
├── patterns/         # Block patterns (10 documentation patterns)
├── templates/        # Block templates (10 page templates)
├── styles/           # Style variations (light, dark, high-contrast, minimal)
├── languages/        # Translation files
├── theme.json        # Global styles and settings
├── functions.php     # Theme functions
├── style.css         # Theme metadata
└── screenshot.png    # Theme preview

Documentation

Document Description
docs/setup.md Installation and initial configuration
docs/architecture.md Theme architecture and file structure
docs/customization.md Colours, typography, navigation, child themes
docs/accessibility.md WCAG compliance and accessibility features
docs/performance.md Optimisation strategy and hosting guidance
docs/handbook-structure.md Organising documentation and page hierarchy
docs/onboarding-guide.md Setting up onboarding documentation
docs/contribution-guide.md Contributing to the theme
docs/wordpress-org-submission.md WordPress.org submission checklist

Block Patterns

Handbook includes 10 purpose-built block patterns:

Pattern Description
Handbook Hero Homepage hero section with search
Documentation Grid Card grid for documentation sections
Onboarding Guide Welcome message, checklist, contacts
Values Grid Company values display cards
Process Steps Numbered step-by-step workflows
Policy Callout Policy summary with metadata
FAQ Section Accessible accordion FAQ
Glossary Layout Alphabetical glossary with navigation
Contributor Guide Contribution workflow documentation
Async Guidelines Async communication principles
Team Directory Team member grid with timezone info

Style Variations

Variation Description
Light Default clean white theme
Dark Dark background for low-light reading
High Contrast Enhanced contrast for accessibility
Minimal Monochrome, typography-focused

Contributing

Contributions are welcome. See docs/contribution-guide.md for the full guide.

  1. Fork the repository.
  2. Create a feature branch from develop.
  3. Follow WordPress Coding Standards.
  4. Submit a pull request.

Changelog

See CHANGELOG.md.


License

Handbook is licensed under the GNU General Public License v2 or later.

All fonts are licensed under the SIL Open Font License 1.1.


Credits

  • Author: Kunal Pareek
  • Fonts: Inter (Rasmus Andersson), Source Serif 4 (Frank Grießhammer), JetBrains Mono (JetBrains)
  • Inspired by: Automattic Handbook, GitLab Handbook, GOV.UK Design System, Stripe Docs

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors