Generate Timeline

Generate Timeline It is a plugin that helps users generate timelines based on folders, tags, files, or metadata. With this plugin, users can easily view and manage their notes in chronological order.

中文文档

Functional Overview

1. Generate Timeline Based on Folders:

   • Select a folder, and the plugin will scan all files (including subfolders) within it to generate a timeline based on the time attributes in the files.
   • Supports both timeline view and Markdown file formats.

   https://github.com/user-attachments/assets/10b64bef-4a07-4e2e-bded-152dc82ab241

2. Generate Timeline Based on Metadata:

   • Input metadata attributes and its value, the plugin will scan all files with matching metadata to generate a timeline based on time attributes.
   • Supports both timeline view and Markdown file formats.

3. Generate Timeline Based on Tags:

   • Select a tag, and the plugin will scan all content with that tag (including subtags) to generate a timeline based on the time attributes.
   • Supports both timeline view and Markdown file formats.

   https://github.com/user-attachments/assets/5da9d7ac-67f1-4c65-bbef-f703696463d8

4. Generate Timeline Based on File Links:

   • Extract all internal links from a specified file and generate a timeline based on the linked files' time attributes.
   • Supports both timeline view and Markdown file formats.

5. Milestone functionality :

   • milestones can be marked with a custom frontmatter attribute.
   • milestone cards have a special style.

   https://github.com/user-attachments/assets/3e92a73a-2af5-4f75-90be-a13aca6c1375

How to Use

1. Generate Timeline from Folder

   • Open the Command Palette and choose one of the following:
     • Generate Timeline: Generate Timeline View from Folder for a timeline view
     • Generate Timeline: Generate Timeline File from Folder for a Markdown file
   • Select your target folder and the timeline will be generated automatically

2. Generate Timeline from Metadata

   • Open the Command Palette and choose one of the following:
     • Generate Timeline: Generate Timeline View from Metadata for a timeline view
     • Generate Timeline: Generate Timeline File from Metadata for a Markdown file
   • Select the metadata attributes and values to filter by

3. Generate Timeline from Tags

   • Open the Command Palette and choose one of the following:
     • Generate Timeline: Generate Timeline View from Tags for a timeline view
     • Generate Timeline: Generate Timeline File from Tags for a Markdown file
   • Select your desired tag and the timeline will be generated automatically

4. Generate Timeline from File Links

   • Open the Command Palette and choose one of the following:
     • Generate Timeline: Generate Timeline View from Current File Links for a timeline view
     • Generate Timeline: Generate Timeline File from Current File Links for a Markdown file
   • Select the source file containing the links

Customization Options

The plugin offers various customization settings:

1. Timeline Appearance:

   • Timeline line width and color
   • Item spacing
   • Card background color, text color and border color
   • Animation duration
   • Milestone card background color, text color and border color

2. Content Settings:

   • Date attribute: Choose which frontmatter date property to use for sorting (e.g., created, updated, date)
   • File name prefix and suffix: Customize the naming pattern for generated timeline files
   • Milestone property settings: custom property names and matching values
   • The card preview preferentially displays the row where the label is located.

3. View Position:

   • Choose whether the timeline view appears in the left or right sidebar

4. Language Settings:

   • Support Chinese and English

Contribution

We welcome contributions of any kind! If you have suggestions, questions, or would like to add new features, please submit an Issue or Pull Request on the GitHub repository.

License

This plugin is released under the MIT License. For more details, please refer to the LICENSE file.