LogoA Template
icon of Jekyll-LibDoc

Jekyll-LibDoc

Jekyll LibDoc: A documentation theme with built-in search and playground for CSS and Javascript libraries, easy to deploy on GitHub Pages.

Introduction

Jekyll LibDoc is a theme designed for creating documentation, especially for CSS and JavaScript libraries. It offers a built-in playground and local search engine.

Key Features:

  • Remote Theme Deployment: Quick setup on GitHub repositories without local installation.
  • Dual Context: Integrated documentation and playground for live demos.
  • Plugin-Free: Operates without Gems or plugins.
  • GitHub Pages Compatible: Easy deployment on GitHub Pages.
  • Layouts: Includes layouts for documentation needs.
  • Assets Grid: Facilitates viewing, downloading, and copying resource URLs.
  • Local Search: Internal search engine using lunr.js.
  • Lazy-Loaded Playgrounds: Add multiple playgrounds that load when in view.
  • Offline Functionality: Works locally with Jekyll serve.
  • Customizable Settings: Editable settings in the config.yml file.
  • Front Matter Support: Utilizes front matter parameters for page customization.
  • GFM Support: Native support for GitHub Flavored Markdown.
  • Metadata: Supports social network metadata.
  • Sidebar: Responsive sidebar for project navigation.

Usage:

  • Online via Remote Theme (GitHub only).
  • Online via GitHub.dev for editing in a browser.
  • Local Installation with Jekyll.
  • Local setup using Jekyll Remote Theme plugin.

Jekyll-LibDoc screenshot | ATemplate.com

A template
Copy badages awards

Newsletter For Templates

Join the Community For Templates

Subscribe to Templates newsletter for the latest news and updates