Jekyll LibDoc

Theme features

  • Quick and easy without installationnew
    Quickly deploy Jekyll LibDoc on a Github repository with remote theme feature
  • Dual context: LibDoc + Playground
    LibDoc was made to craft documentation with its own embedded demos and examples. A major feature of the LibDoc Jekyll theme is its own built-in and configurable playground which is both a layout and a syntax highlighter extension. It extends the syntax highlighter by running the specified code into a configurable context with user defined style sheets and scripts. Learn more
  • Gem free, plugin free
    LibDoc runs without any Gem nor plugin.
  • Github Pages compatible Jekyll theme
    Easily deploy your project on Github Pages, LibDoc is fully compatible.
  • 5 layouts
    LibDoc comes with dedicated layouts for common documentation usages.
  • Assets grid
    Built to allow visitors to view, download or copy URL of specified resources on your project. Example
  • Local search engine
    LibDoc has its own internal search engine based on lunr.js.
  • Multiple lazy-loaded playgrounds on any page
    Add as mush as playgrounds on your documentation pages, playgrounds are loaded once into the viewport.
  • Can work locally, even without Internet connection
    LibDoc can run locally with Jekyll serve or any http host - assuming you set up local resources.
  • Customizeable settings
    LibDoc has its own settings editable on needs in the configuration file config.yml.
  • Front matter
    Optional parameters ready to be set into the front matter of each page and every layout, like category, order in sidebar and unlisted feature. Learn more
  • Github Flavoured Markdown
    LibDoc comes with native support of Github Flavoured Markdown. Learn more
  • Metadata
    LibDoc supports social networks metadata into its document <head> to enable proper social sharing. Favicon, image, author, color, language are supported in addition of site title and description. Metadata have dual settings for both site/project and playground
  • Sidebar
    All the necessary UI components to navigate through your project. Customizeable features such as logo/text management, search engine and possibility to add links of page that are not contained into the project. All available pages of the project are listed into the responsive sidebar, excepting unlisted ones. You can also assign category to pages and set a custom order. Learn more
  • Customizable Logo
    The top left of the LibDoc’s theme is a homepage link that can display just site title or a custom logo. Learn more
  • Pages order and category
    Pages created can optionally have a category and an order assigned through their front matter. Then, it is possible to group pages links in the sidebar with a tip above the link. Learn more
  • Unlisted pages
    It is possible to remove page link from the sidebar and search results thanks to the front matter unlisted property. Learn more
  • Prims as syntax highlighter
    LibDoc uses customizeable Prismjs syntax highlighter for both playground and markdown code highlight. Learn more
  • TOC - Table Of Content
    LibDoc supports {:toc} automatically generated from kramdown - markdown engine - TOC styling the table of content onto a right sidebar. Learn more
  • Shields and badges
    Badge example
    Easily add badges into the footer. Create your own badges and add it through the config.yml. Learn more

Jekyll LibDoc

A Jekyll documentation theme with built-in search and playground.

Theme Information:

Stars : github star13
Forks : github fork17
Updated : 22 Jan 2023
Published : 02 Mar 2021
Types :
Olivier 3lanc
Created byOlivier 3lanc