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.ymlfile. - 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.
