Edition Jekyll Template

Theme by Cloudcannon

|

Updated: 26 Sep 2023

|

366 Stars

:books: Product documentation template for Jekyll

Categories

Product Analysis: EditionProduct Documentation Template for Jekyll

Overview:

EditionProduct is a configurable theme for Jekyll that allows users to easily document their product, application, service, or website. It provides a two-column layout, full-text search, pre-styled components, auto-generated navigation based on categories, and optimization for editing in CloudCannon. The theme was created by CloudCannon, a Cloud CMS for Jekyll, and is designed to be user-friendly and adaptable for different versions of Jekyll.

Features:

• Two column layout: EditionProduct offers a two-column layout, allowing users to display content and navigation side by side.
• Full-text search: Users can take advantage of a powerful search feature that enables them to search for specific content within the documentation.
• Pre-styled components: EditionProduct includes pre-styled components, making it easy for users to create visually appealing and consistent documentation.
• Auto-generated navigation: The theme automatically generates navigation based on categories, simplifying the organization of documentation pages.
• Optimized for editing in CloudCannon: EditionProduct has been optimized for use with CloudCannon, allowing users to easily add, update, and remove documentation pages.
• Change log: Users can add, update, or remove change log entries from their posts, keeping track of updates and improvements made to their product.
• RSS/Atom feed: EditionProduct supports RSS and Atom feeds, allowing users to provide regular updates to their audience.
• SEO tags: Users can optimize their documentation for search engines by adding SEO tags, improving the discoverability of their content.
• Google Analytics: EditionProduct integrates with Google Analytics, giving users insights into their website’s performance and audience.

Installation:

To install the EditionProduct theme, follow these steps:

1. Add your site and author details in the _config.yml file.
2. Set up a workflow to see your site’s output, either with CloudCannon or by running Jekyll locally.
3. Ensure you have the correct version of Jekyll. EditionProduct was built with Jekyll version 3.3.1 but should support newer versions as well.
4. Install the dependencies with Bundler:

bundle install

5. Run Jekyll commands through Bundler to ensure you’re using the correct versions:

bundle exec jekyll build

Summary:

EditionProduct is a versatile theme for Jekyll that simplifies the process of documenting products, applications, services, or websites. With its user-friendly features, such as the two-column layout, full-text search, and auto-generated navigation, EditionProduct makes it easy for users to create and maintain comprehensive documentation. With its optimization for editing in CloudCannon and integration with tools like Google Analytics, EditionProduct provides a seamless experience for users.