Real Testimonials

Appearance

Real Testimonials Documentation ​

The official documentation site for Real Testimonials — the most customizable WordPress testimonials & reviews plugin, by ShapedPlugin LLC.

Built with VitePress.

Local development ​

bash
# Install dependencies
npm install

# Start the dev server (hot reload) at http://localhost:5173
npm run docs:dev

# Build the static site into .vitepress/dist
npm run docs:build

# Preview the production build locally
npm run docs:preview

Project structure ​

realtestimonials-docs/
├── .vitepress/
│   └── config.mjs          # Site config: nav, sidebar, search, sitemap
├── index.md                # Home page (hero + feature grid)
├── guide/                  # Documentation
│   ├── introduction.md · installation.md · requirements.md · quick-start.md
│   ├── blocks-overview.md · add-new-testimonial.md · hooks.md (developer reference)
│   ├── blocks/             # One page per block (display, social, child, form, shortcode)
│   ├── classic/            # Classic (shortcode) version: overview, Views, layouts, forms
│   └── dashboard/          # Admin dashboard pages
├── public/                 # Served at the web root (images, logo, favicon)
│   └── images/             # Screenshots (.webp), organized by section
├── SCREENSHOTS.md          # Checklist of every screenshot to capture
└── package.json

The changelog is not an in-site page — the top nav links out to realtestimonials.io/changelog.

Writing conventions ​

  • Each page starts with a single # H1, then uses ##/### for sections.
  • Images live in public/images/<section>/ and are referenced as /images/<section>/<file>.webp (the public folder is the web root, so it's omitted from the path).
  • Use WebP images, ~1600px wide, captured in light theme for consistency.
  • Document blocks against their real inspector panels; the Carousel page carries the full shared-panel reference that other display pages link to.
  • Classic-version pages (guide/classic/) are verified against the plugin's classic admin UI config, not older docs sites.

Screenshots ​

Every required screenshot is tracked in SCREENSHOTS.md. The build fails if a live ![](...) reference points at a file missing from public/, so a screenshot that hasn't been captured yet must stay as an HTML comment until the file exists. Each image reference is preceded by a comment describing what to capture, e.g.:

md
<!-- SCREENSHOT: a Grid of testimonial cards on the editor canvas, inspector open on the Layouts panel -->
![Grid block in the editor](/images/blocks/grid-editor.webp)

Deployment ​

The static output in .vitepress/dist deploys to any static host (Netlify, Vercel, GitHub Pages, Cloudflare Pages, or a subdomain such as docs.realtestimonials.io). Build command: npm run docs:build; publish directory: .vitepress/dist.

Last updated: