Skip to main content

Crate gitkyl

Crate gitkyl 

Source
Expand description

Static site generator for Git repositories.

Re-exports§

pub use avatar::render;
pub use components::icons::is_markdown;
pub use components::icons::is_readme;

Modules§

avatar
Avatar generation for author profiles
components
Reusable HTML components for page generation
pages
Page generation modules for different view types

Structs§

BlameLine
Single line of blame output with commit attribution.
BlameResult
Blame result with lines and metadata.
ChangedFile
Changed file in commit diff.
CommitDiff
Full commit diff with all changed files.
CommitInfo
Commit metadata.
Config
Command line configuration for Gitkyl.
DiffHunk
Diff hunk with header and lines.
DiffLine
Single line in a diff hunk.
FileEntry
File entry in repository tree.
FileStats
File statistics for diff.
FileTree
In-memory representation of repository directory tree.
Highlighter
Syntax highlighting engine with lazy-loaded syntaxes and themes.
LinkResolver
Resolves relative links in markdown to static blob/tree pages.
MarkdownRenderer
Renders markdown to HTML with GitHub Flavored Markdown extensions.
PaginatedCommits
Paginated commits result with navigation metadata.
RepoInfo
Repository metadata.
TagInfo
Git tag with metadata.

Enums§

ChangeType
Type of file change in commit.
DiffLineType
Line change in a diff hunk.
FileType
File type classification for blob rendering
ImageFormat
Supported image formats for inline display
TreeItem
Represents an item in a directory tree view.

Functions§

analyze_repository
Analyzes a git repository and extracts metadata.
blame_file
Computes blame for a file, attributing each line to its originating commit.
detect_file_type
Detects file type from path and content.
get_commit_by_oid
Retrieves a single commit by its OID.
get_commit_diff
Computes diff for a commit against its parent.
get_last_commits_batch
Batch lookup last commits for multiple files in single history walk.
highlight
Highlights source code with syntax highlighting.
is_binary_content
Checks if byte content is binary.
list_commits
Lists commits for a given reference in reverse chronological order.
list_commits_paginated
Lists commits with pagination support.
list_files
Lists all files in repository at given reference.
list_tags
Lists all tags in the repository with metadata.
read_blob
Reads blob content from repository at given reference and path.
read_blob_by_oid
Reads blob content directly by object ID.
write_css_assets
Writes all bundled CSS assets to output directory