Jamdocs

Jamdocs is an open-source static documentation theme for the JAM-stack, built on Gridsome, that lets you deploy a full documentation site to Netlify in one click.

What is Jamdocs?

Jamdocs is a static documentation theme built on Gridsome, a Vue-based static site generator. It takes Markdown content (managed via Forestry CMS) and produces a fast, deployable documentation website optimized for the JAM-stack. The theme is created by Samuel Horn and is distributed under the MIT license. According to the repository, it scores 100/100/100/100 in Google Lighthouse.

Key Features

• Fast by default — The theme reports perfect 100/100/100/100 scores in Google Lighthouse and 100/100 in Google PageSpeed Insights.
• One-click Netlify deploy — A dedicated Deploy to Netlify button sets up a continuous deployment pipeline directly from the GitHub repository.
• Forestry CMS integration — Pre-configured to import to Forestry, a headless CMS, so content edits commit back to the repo.
• Gridsome-based — Built on Gridsome, a Vue-powered static site generator, so customization uses Vue components and GraphQL.
• Built-in demo/documentation — The demo site doubles as the documentation, at jamdocs.samuelhorn.com.
• MIT licensed — Free to use, modify, and incorporate in commercial projects.

Who is it for?

• Technical writers who want to publish documentation for open-source projects quickly.
• JAM-stack developers seeking a pre-built docs theme that deploys to Netlify.
• Teams using Forestry CMS who need a docs site that integrates with their existing content workflow.

What can you do with Jamdocs?

• Open-source maintainers: Publish project documentation as a static site with one-click Netlify deployment.
• Startups: Create a public docs site for a product without building from scratch, using Gridsome and Vue components.
• Content teams: Manage documentation content via Forestry's headless CMS with automatic commits to the repository.

How does Jamdocs work?

Clone the repository with git clone https://github.com/samuelhorn/jamdocs project-name, then run gridsome develop to start a local development server. When ready, click the Deploy to Netlify button to set up hosting and continuous deployment, or import the repository into Forestry to manage content through its visual CMS.

Pros and cons

• Pros: Excellent performance scores (100/100/100/100 Lighthouse), free MIT license, easy deployment via Netlify, pre-configured Forestry CMS integration.
• Cons: Still in heavy development and documentation is incomplete; the demo site itself serves as the (unfinished) documentation.

Pricing

Jamdocs is free and open-source under the MIT license. No paid tiers or licensing fees are mentioned.

Alternatives

• VuePress — another Vue-based static site generator with a built-in documentation theme.
• Docusaurus — a React-based documentation generator focused on open-source projects.

FAQ

Is Jamdocs free?

Yes, Jamdocs is open-source under the MIT license, so it can be used freely, including in commercial projects.

How fast is a Jamdocs site?

The theme reports perfect scores of 100/100/100/100 in Google Lighthouse and 100/100 in Google PageSpeed Insights.

Do I need to know Vue.js to use Jamdocs?

Since Jamdocs is built on Gridsome, customizing the theme typically requires familiarity with Vue components and GraphQL queries. Basic usage just requires writing content.

Can I manage content with a CMS?

Yes, Jamdocs is pre-configured to work with Forestry, a headless CMS. Edits made in Forestry are committed back to the GitHub repository.

Is Jamdocs production-ready?

The repository warns that Jamdocs is still in heavy development and its documentation is incomplete, so it may change significantly in the near future.