Skip to content

Website - adding in all storage adapters and cleanup #673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Feb 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,10 @@ keyv.iml
#vim
*.swp

#website
packages/website/site/docs/caching/caching-*.md
packages/website/site/docs/compression/compress-*.md
packages/website/site/docs/storage-adapters/*.md
!packages/website/site/docs/storage-adapters/storage-dapters.md
packages/website/site/docs/index.md
packages/website/site/_data/github.json
6 changes: 6 additions & 0 deletions docs/caching/caching-express.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: 'How to Implement Caching with Express'
sidebarTitle: 'Caching with Express'
parent: 'Caching'
---

# How to Implement Caching with Express

## What is Express?
Expand Down
5 changes: 5 additions & 0 deletions docs/caching/caching-fastify.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 'How to Implement Caching with Fastify'
sidebarTitle: 'Caching with Fastify'
parent: 'Caching'
---

# How to Implement Caching with Fastify

Expand Down
8 changes: 7 additions & 1 deletion docs/caching/caching-javascript.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# How to Implement Caching with Javascript
---
title: 'How to Implement Caching in Javascript'
sidebarTitle: 'Caching in Javascript'
parent: 'Caching'
---

# How to Implement Caching in Javascript

## What is a Cache?
A cache is a short-term, high-speed data storage layer that stores a subset of data, enabling it to be retrieved faster than accessing it from its primary storage location. Caching allows you to reuse previously retrieved data efficiently.
Expand Down
5 changes: 5 additions & 0 deletions docs/caching/caching-koa.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: 'How to Implement Caching with Koa'
sidebarTitle: 'Caching with Koa'
parent: 'Caching'
---

# How to Implement Caching with Koa

Expand Down
6 changes: 6 additions & 0 deletions docs/caching/caching-nestjs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: 'How to Implement Caching with NestJS'
sidebarTitle: 'Caching with NestJS'
parent: 'Caching'
---

# How to Implement Caching with NestJS

## What is NestJS ?
Expand Down
7 changes: 6 additions & 1 deletion docs/caching/caching-node.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
---
title: 'How to Implement Caching in Node.js'
sidebarTitle: 'Caching in Node.js'
parent: 'Caching'
---

# How to Implement Caching with Node.js
# How to Implement Caching in Node.js

## What is Node.js?

Expand Down
28 changes: 0 additions & 28 deletions docs/storage-adapter/amazon-documentdb-storage-adapter.md

This file was deleted.

2 changes: 1 addition & 1 deletion packages/compress-brotli/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @keyv/compress-brotli [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwray/keyv)
# @keyv/compress-brotli [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)

> Brotli compression for Keyv

Expand Down
2 changes: 1 addition & 1 deletion packages/compress-gzip/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @keyv/compress-gzip [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwray/keyv)
# @keyv/compress-gzip [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)

> Gzip compression for Keyv

Expand Down
5 changes: 2 additions & 3 deletions packages/memcache/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
[<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwray/keyv)
# @keyv/memcache [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)

# @keyv/memcache
_Memcache storage adapter for [Keyv](https://github.com/jaredwray/keyv)_
> Memcache storage adapter for [Keyv](https://github.com/jaredwray/keyv)


[![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)
Expand Down
2 changes: 1 addition & 1 deletion packages/mysql/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @keyv/mysql [<img width="100" align="right" src="https://rawgit.com/lukechilds/keyv/master/media/logo.svg" alt="keyv">](https://github.com/jaredwray/keyv)
# @keyv/mysql [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)

> MySQL/MariaDB storage adapter for Keyv

Expand Down
2 changes: 1 addition & 1 deletion packages/offline/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @keyv/offline [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwray/keyv)
# @keyv/offline [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)

> offline storage adapter for Keyv

Expand Down
2 changes: 1 addition & 1 deletion packages/postgres/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @keyv/postgres [<img width="100" align="right" src="https://rawgit.com/lukechilds/keyv/master/media/logo.svg" alt="keyv">](https://github.com/lukechilds/keyv)
# @keyv/postgres [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)

> PostgreSQL storage adapter for Keyv

Expand Down
2 changes: 1 addition & 1 deletion packages/sqlite/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @keyv/sqlite [<img width="100" align="right" src="https://rawgit.com/lukechilds/keyv/master/media/logo.svg" alt="keyv">](https://github.com/lukechilds/keyv)
# @keyv/sqlite [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)

> SQLite storage adapter for Keyv

Expand Down
2 changes: 1 addition & 1 deletion packages/tiered/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @keyv/tiered [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwray/keyv)
# @keyv/tiered [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)

> Tiered storage adapter for Keyv to manage local and remote store as one for Keyv

Expand Down
11 changes: 9 additions & 2 deletions packages/website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,17 @@
"private": true,
"scripts": {
"test:ci": "echo 'no tests needed'",
"build": "docula build",
"generate-docs": "ts-node ./src/docs.ts",
"build": "yarn generate-docs && docula build",
"build-serve": "yarn generate-docs && docula serve",
"serve": "docula serve"
},
"devDependencies": {
"docula": "^0.0.9"
"@types/fs-extra": "^11.0.1",
"docula": "^0.0.9",
"ts-node": "^10.9.1"
},
"dependencies": {
"fs-extra": "^11.1.0"
}
}
Loading