Jekyll Lab Notebook

Theme by Tlnagy

|

Updated: 9 Sep 2020

|

64 Stars

A full-featured electronic lab notebook theme (with plugins!) for Jekyll

Overview:

The jekyll-lab-notebook is a full-featured jekyll theme that allows users to quickly write markdown notebook entries and generate a locally runnable HTML website. It is highly customizable and can be easily tweaked and modified to suit individual needs.

Features:

• Simple Markdown Notes: Users can take simple markdown notes in their favorite text editor.
• Embedded Files: Users can easily embed images, CSVs, or PDFs in their protocols/logs.
• Interactive Calendar: The theme includes an interactive calendar that displays the dates of log entries.
• Tagging System: Users can tag their log entries to organize and group them by project or other categories.
• Highlighted Sections: Users can add highlighted sections like note or thought bubbles to draw attention to important information.

Installation:

To install jekyll-lab-notebook, follow these steps:

1. Clone this repository and navigate into the demo/ folder.
2. Ensure that you have a recent version of Ruby installed.
3. Run bundle install to install the bundle package manager.
4. Run bundle install to install all the necessary packages.
5. Run bundle exec jekyll serve to serve the ELN.
6. Open your browser and navigate to the address listed to see your ELN.
7. Edit the posts inside the _posts/ subdirectory to add entries.

Summary:

Overall, jekyll-lab-notebook is a powerful and customizable jekyll theme for creating electronic lab notebooks. With its simple markdown notes, embedded files, interactive calendar, tagging system, and highlighted sections, it provides a comprehensive solution for researchers to document their work. The installation process is straightforward and users can easily modify the theme to meet their specific requirements.