https://github.com/ita-design-system/eleventy-libdoc

An Eleventy starter project to craft slick documentation
https://github.com/ita-design-system/eleventy-libdoc

documentation-tool eleventy eleventy-blog eleventy-starter

Last synced: 5 months ago
JSON representation

An Eleventy starter project to craft slick documentation

• Host: GitHub
• URL: https://github.com/ita-design-system/eleventy-libdoc
• Owner: ita-design-system
• Created: 2025-01-30T14:20:11.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2025-05-13T07:48:45.000Z (5 months ago)
• Last Synced: 2025-05-13T08:35:56.836Z (5 months ago)
• Topics: documentation-tool, eleventy, eleventy-blog, eleventy-starter
• Language: CSS
• Homepage: https://eleventy-libdoc.netlify.app/
• Size: 8.41 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Eleventy LibDoc

[Eleventy LibDoc website](https://eleventy-libdoc.netlify.app/) | [11ty website](https://www.11ty.dev)

Eleventy LibDoc is a starter project for Eleventy to craft slick web related code documentation.

[![Netlify Status](https://api.netlify.com/api/v1/badges/d1986dbf-2272-4614-8dec-c228ba4699ef/deploy-status)](https://app.netlify.com/sites/11ty-libdoc-blank/deploys)

![image](https://github.com/user-attachments/assets/8011e835-0d6d-404d-b068-5a9b42b6c07d)



## Getting started

1. Clone or fork 

2. Run `npm install`

3. Enter your own settings in `settings.json`. [Configuration](/content/configuration/index.md).

4. Build `npx @11ty/eleventy`

[View deployment of this repository](https://11ty-libdoc-blank.netlify.app)

## 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** 
Quickly get search results and easily navigate through search occurrences with a dedicated UI.

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

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

## Documentation

* [LibDoc’s homepage](https://eleventy-libdoc.netlify.app) 
The website containing LibDocs’s presentation and comprehensive documentation.

    * [Front matter](https://eleventy-libdoc.netlify.app/front-matter/) 
Documentation of all front matter settings related to a LibDoc page.

    * [Primary navigation](https://eleventy-libdoc.netlify.app/primary-navigation/) 
Detailed features of LibDoc’s primary navigation.

    * [SEO](https://eleventy-libdoc.netlify.app/configuration/seo/) 
How LibDoc’s configuration and pages parameters are applied for Search Engine Optimization.

    * [Credits](https://eleventy-libdoc.netlify.app/configuration/credits/) LibDoc could not work without these resources.