Eleventy LibDoc

Eleventy LibDoc website | 11ty website

Eleventy LibDoc is an easy to use and content focused starter project for Eleventy to craft slick and responsive documentation. It was was developed with accessibility awareness and low-tech mindset which allows to reach good page speed performances. It contains vanilla JS self-made components like search, primary navigation, table of content, code highlighting and sandboxes. Every page created with LibDoc is printable and can work properly even without Javascript by maintaining only essential features.

Note

Eleventy LibDoc is still under active development and therefore before reaching v1.0.0:

• Full backward compatibility is not guaranteed.
• Many features are subject to change.

Getting started

1. Clone or fork https://github.com/ita-design-system/eleventy-libdoc
2. Run npm install
3. Enter your own settings in settings.json. Configuration.
4. Build npx @11ty/eleventy --serve or npx @11ty/eleventy (if you already have your own web server).

View deployment of this repository

Key features

• Content focused
  LibDoc is easy to install, deploy and use.
• Accessibility
  LibDoc was developed with accessibility awareness.
• Performance
  Low front-end dependencies and vanilla JS self-made components make LibDoc cross-browser compatibility and good performances. View performances.
• Search
  Fuzzy and standard search modes. Keyboard shortcut 🆂 allows quick focus on search input field. Fuzzy search makes easy keyboard based navigation whereas standard search allows to find an exact match..
• Smart navigation
  On page change, the primary navigation menu keeps its position.
• Smart table of content
  In addition of a pure static table of content, LibDoc generates a floating TOC always visible that also displays the current window scroll position.
• Fallback if no Javascript available
  LibDoc can work even without Javascript with reduced features.
• Image transcoding
  LibDoc transcodes and resizes your source images into production ready formats.
• Printable
  Every page created with LibDoc can be printed.
• Light and dark modes
  LibDoc’s interface is available with both light and dark mode color schemes.
• Slick code highlighting
  Display your code in a nice style and adjust which code languages you really use.
• Sandboxes
  Showcase small demos or full HTML pages into a responsive dual pane.
• Atom feed
  The Atom feed allows visitors to subscribe to post blog content.

Documentation

• LibDoc’s homepage
  The website containing LibDocs’s presentation and comprehensive documentation.
  • Configuration
    List and descriptions of every LibDoc parameter.
  • Creating content
    How LibDoc can display your content in multiple ways.
  • Front matter
    Documentation of all front matter settings related to a LibDoc page.
  • Primary navigation
    Detailed features of LibDoc’s primary navigation.
  • SEO
    How LibDoc’s configuration and pages parameters are applied for Search Engine Optimization.
  • Credits
    LibDoc could not work without these resources.