Eleventy LibDoc

An Eleventy starter project to craft slick and responsive documentation

ITADS

Table of content
  1. Key features
  2. Getting started
  3. Update LibDoc
  4. Configuration
  5. Creating content
  6. Primary navigation
  7. Files tree

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.

Current version is 0.14.9 - View change log.

Key features

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 and serve npx @11ty/eleventy --serve or just build npx @11ty/eleventy (if you already have your own web server).

Update LibDoc

This process shows how to update Eleventy LibDoc Starter template.

  1. Delete the following files and folders:
    • _data
    • _includes
    • core
    • node_modules
    • .eleventy.js
    • package-lock.json
    • package.json
  2. Replace the same files and folders from the new Eleventy LibDoc version.
  3. Run npm install, then you get the latest version. You can verify current version at the bottom of each page.

Configuration

Start entering your own settings into settings.json at the root of the project. Configuration documentation.

Creating content

Easily write documentation with Markdown and HTML.

Primary navigation

One of the most important element of the user interface. Primary navigation documentation

Files tree