Overview

Eleventy Notes is a beta version template designed for publishing personal notes, documentation, or blogs. It is built using Eleventy, a static site generator. Users are encouraged to report bugs or provide suggestions by opening an issue.

Features

• Wikilinks and backlinks: Users can navigate between related notes easily.
• Support for Tags: Organize and categorize notes with tags.
• Fast client-side search: Quickly search for specific content within the site.
• Two Themes and multiple color schemes: Choose from different themes and color schemes to customize the look of the site.
• Customizable Sidebar with folder support: Customize the sidebar to display folders and categories.
• Lightweight and fast: The template has minimal JavaScript, ensuring a fast and efficient browsing experience.

Installation

To install the Eleventy Notes template, follow these steps:

1. Clone the repository:

   git clone [repository-url]
   

2. Navigate to the cloned directory:

   cd [directory-name]
   

3. Install the dependencies:

   npm install
   

4. Build the site:

   npm run build
   

5. Start the local server:

   npm run serve
   

6. Open a web browser and visit http://localhost:8080/ to see the Eleventy Notes template in action.

Summary

Eleventy Notes is a beta version template built using Eleventy, a static site generator. It allows users to publish their personal notes, documentation, or blogs. The template offers several features such as wikilinks, support for tags, a fast client-side search, customizable themes and sidebar, as well as being lightweight and fast. Installation is straightforward, and users can see the template in action by visiting the provided documentation.