Contribute

Overview

A modular, production-ready open-source framework for building professional developer portfolios, documentation sites, and project showcases.

Quick Install

Get started in under 30 seconds. Requires Node.js 18+.

npm create pp-template@latest
After installation, run npm run dev to start the local server.
Version v3.2.1-stable
License MIT / BSD-3
Language TypeScript / HTML5
CI Status ● Passing
Bundler Vite / Webpack
SSR Support Yes (Optional)

Core Features

Designed for developers who value performance, accessibility, and clean architecture.

Zero-Config Setup

Out-of-the-box sensible defaults. No complex configuration files required to get started.

🔌

Plugin Ecosystem

Extend functionality with a robust plugin API. Add analytics, SEO, or custom components effortlessly.

Accessibility First

WCAG 2.1 AA compliant by default. Semantic HTML, ARIA labels, and keyboard navigation built-in.

🌐

i18n Ready

Built-in internationalization support with fallback languages and RTL layout detection.

🎨

Theme Engine

Customizable design tokens. Switch between light/dark modes or inject your own brand palette.

📊

Performance Optimized

Code splitting, lazy loading, and tree-shaking enabled by default. Consistently scores 90+ on Lighthouse.

Documentation

Comprehensive guides, API references, and implementation examples.

Getting Started

Begin by installing the CLI and initializing a new project directory. The scaffolded structure includes essential files, configuration presets, and example data.

# Initialize project
npx pp-cli init my-portfolio

# Navigate into directory
cd my-portfolio

# Install dependencies
npm install

# Start development server
npm run dev

Once the server is running, visit http://localhost:3000 to view the default template. Edit files in the /src directory to begin customizing your portfolio.

For detailed configuration options, refer to the pp.config.ts documentation in the API reference section.

Open Source Projects

Repositories maintained by the core team and community contributors.

pp-core ⭐ 1.2k

Core runtime and build system. Handles module resolution, bundling, and hot module replacement.

📦 v3.2.1 🐛 4 open issues 🔀 12 PRs
pp-plugin-markdown ⭐ 842

Markdown rendering plugin with syntax highlighting, table of contents, and frontmatter parsing.

📦 v2.0.5 🐛 1 open issue 🔀 3 PRs
example-minimal ⭐ 567

Boilerplate for developers wanting a clean, unopinionated starting point with zero dependencies.

📦 v1.1.0 🐛 0 open issues 🔀 1 PR
pp-plugin-analytics ⭐ 412

Privacy-first analytics integration supporting Plausible, Umami, and custom endpoints.

📦 v1.3.2 🐛 2 open issues 🔀 5 PRs
pp-cli ⭐ 980

Command-line interface for scaffolding, building, and managing portfolio deployments.

📦 v3.1.0 🐛 0 open issues 🔀 2 PRs
example-docs-site ⭐ 334

Reference implementation showcasing navigation, search, and versioned documentation patterns.

📦 v2.0.0 🐛 1 open issue 🔀 0 PRs

Community & Contributors

Built by developers, for developers. Join a growing open-source community.

👤

alex_dev

Core Maintainer

👤

sarah_codes

Plugin Author

👤

marcus_builds

Documentation Lead

👤

luna_ui

Accessibility Reviewer

💬 Discord Server 🐙 GitHub Discussions 📜 Code of Conduct

How to Contribute

We welcome all contributions, from documentation fixes to major feature implementations.

1

Fork Repository

Create a personal fork of the main repository on GitHub to propose changes.

2

Create Branch

Use semantic naming: feat/name or fix/name.

3

Implement & Test

Run npm run test and ensure 100% coverage for new code.

4

Submit PR

Fill out the pull request template. Link related issues and provide screenshots if applicable.

Note: All submissions are subject to our Contributor License Agreement (CLA). By submitting a pull request, you agree to license your contribution under the project's MIT/BSD license.
"}