Mkdocs Jekyll

Overview:

The MkDocs Jekyll Theme is a starter template for a MkDocs Jekyll theme. It is based on the previous works of alexcarpenter/material-jekyll-theme and squidfunk/mkdocs-material. This theme allows users to create documentation websites using the MkDocs and Jekyll frameworks.

Features:

• Starter Template: Provides a ready-to-use template for creating documentation websites.
• Customizable Configuration: Users can easily customize the configuration values by editing the _config.yml file.
• Page Management: Users can add new pages to their documentation by writing them into the pages folder.
• Navigation System: The theme automatically generates a navigation menu based on the pages and their permalink attributes.
• Self-Explanatory Configuration: Most of the configuration values in the _config.yml file are self-explanatory.
• Detailed Documentation: Users can find more details about configuration options in the about page rendered on the site.

Installation:

1. Clone the repository to the desired location for hosting the documentation:

git clone <repository_url>

2. Customize the configuration values by editing the _config.yml file.
3. Add new pages by writing them into the pages folder. Define the page URLs based on the permalink attribute in your pages.
4. Optionally, update the navigation menu by adding the desired pages to the content of _data/toc.yml.

Summary:

The MkDocs Jekyll Theme is a convenient and customizable solution for creating documentation websites. It combines the power of MkDocs and Jekyll to provide a user-friendly and feature-rich platform for managing and presenting documentation. With its easy installation process and customizable options, users can quickly set up and tailor their documentation websites according to their needs.