Sprucecss Eleventy Documentation Template

Overview:

The Spruce Docs Elventy theme is a self-hosted documentation template built on Eleventy, a static site generator. It offers a simple and customizable structure with breadcrumb navigation, HTML minification, anchor headings, table of content, FAQ template, Changelog template, static search integration, code highlighting, RTL support, and dark theme mode. The theme also includes a custom CSS framework called Spruce CSS.

Features:

• Breadcrumb navigation built on 11ty Navigation Plugin
• HTML minification in production mode
• Anchor headings
• Table of Content
• FAQ template
• Changelog template
• Static search integration with pagefind
• Code highlighting
• RTL support
• Dark theme mode
• svgIcon shortcode: render any SVG icon inline and add optional classes
• markdownRenderer: render any string (markdown) into HTML

Installation:

To install the Spruce Docs Elventy theme, follow these steps:

1. Clone the repository:

git clone [repository-url]

2. Install the dependencies:

npm install

3. Run the development mode:

npm run dev

This command will also watch for changes in the code.

4. Run the production mode:

Before going live, compress the Sass files using the production script:

npm run build

Additional npm scripts are available in the package.json file for other helpful tasks.

Summary:

The Spruce Docs Elventy theme is a self-hosted documentation template built on Eleventy. It offers a simple structure and a wide range of features for creating documentation websites. With its custom CSS framework, Spruce CSS, and support for RTL and dark theme mode, the theme provides flexibility for customization. The theme also includes useful templates, such as FAQ and Changelog, as well as features like static search integration and code highlighting. Overall, the Spruce Docs Elventy theme is a comprehensive solution for creating professional and user-friendly documentation websites.