cache-kit 0.9.0

A type-safe, fully generic, production-ready caching framework for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

# Jekyll configuration for cache-kit documentation
# Using Minimal Mistakes theme

# Site settings
title: "cache-kit"
masthead_title: "cache-kit"
title_separator: "|"
subtitle: ""
description: "Async, ORM-agnostic caching boundaries for Rust services"
tagline: "Async, ORM-agnostic caching boundaries for Rust services"
baseurl: ""
url: "https://cachekit.org"
repository: "megamsys/cache-kit.rs"

# Theme
theme: minimal-mistakes-jekyll
minimal_mistakes_skin: "dark" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"

# Site Author
author:
  name: "Kishore Kumar Neelamegam"
  avatar: "/assets/images/bio-photo.png"
  bio: "Async, ORM-agnostic caching for Rust"
  location: "Global"
  links:
    - label: "GitHub"
      icon: "fab fa-fw fa-github"
      url: "https://github.com/megamsys/cache-kit.rs"
    - label: "crates.io"
      icon: "fas fa-fw fa-box"
      url: "https://crates.io/crates/cache-kit"

# Site Footer
footer:
  links:
    - label: "GitHub"
      icon: "fab fa-fw fa-github"
      url: "https://github.com/megamsys/cache-kit.rs"
    - label: "crates.io"
      icon: "fas fa-fw fa-box"
      url: "https://crates.io/crates/cache-kit"

# Collections
collections:
  pages:
    output: true
    permalink: /:path/

# Reading Files
include:
  - _pages
exclude:
  - README.md
  - Gemfile
  - Gemfile.lock
  - node_modules
  - vendor/bundle/
  - vendor/cache/
  - vendor/gems/
  - vendor/ruby/

# Conversion
markdown: kramdown
highlighter: rouge
kramdown:
  input: GFM
  hard_wrap: false
  auto_ids: true
  footnote_nr: 1
  entity_output: as_char
  toc_levels: 1..6
  smart_quotes: lsquo,rsquo,ldquo,rdquo
  syntax_highlighter: rouge
  syntax_highlighter_opts:
    css_class: 'highlight'
    block:
      line_numbers: false

# Outputting
permalink: /:title/
timezone: UTC

# Plugins
plugins:
  - jekyll-seo-tag
  - jekyll-sitemap
  - jekyll-gist
  - jekyll-include-cache

# SEO
locale: "en-US"

# Social Sharing
twitter:
  username: &twitter "indykish"
social:
  type: Organization
  name: cache-kit
  links:
    - "https://github.com/megamsys/cache-kit.rs"
    - "https://x.com/indykish"

# Analytics
analytics:
  provider: false

# Comments
comments:
  provider: false

# Search
search: true
search_full_content: true
search_provider: lunr

# Defaults
defaults:
  # Pages collection
  - scope:
      path: ""
      type: pages
    values:
      layout: single
      author_profile: false
      read_time: false
      comments: false
      share: false
      related: false
      search: true
      sidebar:
        nav: "docs"