mirror/phpredis
1
0
Fork 0
mirror of https://github.com/phpredis/phpredis.git synced 2026-06-19 07:35:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Initial syntax highlighing integration

Browse Source
This commit is contained in:
michael-grunder
2025-11-08 20:47:49 -08:00
committed by Michael Grunder
parent b30fe1d1c7
commit 1297c48c14
21 changed files with 1536 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Redis.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>Redis | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/RedisArray.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>RedisArray | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/RedisCluster.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>RedisCluster | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/RedisClusterException.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>RedisClusterException | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/RedisException.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>RedisException | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/RedisSentinel.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>RedisSentinel | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/[Global_Namespace].html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>[Global Namespace] | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/classes.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>All Classes | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/css/highlight-github.min.css
Vendored
+10
View File
@@ -0,0 +1,10 @@
pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}/*!
Theme: GitHub
Description: Light theme as seen on github.com
Author: github.com
Maintainer: @Hirse
Updated: 2021-05-15
Outdated base version: https://github.com/primer/github-syntax-light
Current colors taken from GitHub's CSS
*/.hljs{color:#24292e;background:#fff}.hljs-doctag,.hljs-keyword,.hljs-meta .hljs-keyword,.hljs-template-tag,.hljs-template-variable,.hljs-type,.hljs-variable.language_{color:#d73a49}.hljs-title,.hljs-title.class_,.hljs-title.class_.inherited__,.hljs-title.function_{color:#6f42c1}.hljs-attr,.hljs-attribute,.hljs-literal,.hljs-meta,.hljs-number,.hljs-operator,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-id,.hljs-variable{color:#005cc5}.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#032f62}.hljs-built_in,.hljs-symbol{color:#e36209}.hljs-code,.hljs-comment,.hljs-formula{color:#6a737d}.hljs-name,.hljs-quote,.hljs-selector-pseudo,.hljs-selector-tag{color:#22863a}.hljs-subst{color:#24292e}.hljs-section{color:#005cc5;font-weight:700}.hljs-bullet{color:#735c0f}.hljs-emphasis{color:#24292e;font-style:italic}.hljs-strong{color:#24292e;font-weight:700}.hljs-addition{color:#22863a;background-color:#f0fff4}.hljs-deletion{color:#b31d28;background-color:#ffeef0}
docs/doc-index.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>Index | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/index.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>All Classes | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/interfaces.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>Interfaces | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/namespaces.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>Namespaces | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/search.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>Search | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
docs/traits.html
+19 -1
View File
@@ -5,7 +5,7 @@
<meta name="robots" content="index, follow, all" />
<title>Traits | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
@@ -16,6 +16,24 @@
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
doctum-config.php
+4
View File
@@ -17,6 +17,10 @@ return new Doctum($iterator, [
'source_dir' => $root,
'build_dir' => $root . '/docs',
'cache_dir' => $root . '/docs/.cache',
'theme' => 'phpredis',
'template_dirs' => [
$root . '/doctum-theme',
],
'base_url' => 'https://phpredis.github.io/',
'remote_repository' => new GitHubRemoteRepository(
'phpredis/phpredis',
doctum-theme/css/highlight-github.min.css
Vendored
+10
View File
@@ -0,0 +1,10 @@
pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}/*!
Theme: GitHub
Description: Light theme as seen on github.com
Author: github.com
Maintainer: @Hirse
Updated: 2021-05-15
Outdated base version: https://github.com/primer/github-syntax-light
Current colors taken from GitHub's CSS
*/.hljs{color:#24292e;background:#fff}.hljs-doctag,.hljs-keyword,.hljs-meta .hljs-keyword,.hljs-template-tag,.hljs-template-variable,.hljs-type,.hljs-variable.language_{color:#d73a49}.hljs-title,.hljs-title.class_,.hljs-title.class_.inherited__,.hljs-title.function_{color:#6f42c1}.hljs-attr,.hljs-attribute,.hljs-literal,.hljs-meta,.hljs-number,.hljs-operator,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-id,.hljs-variable{color:#005cc5}.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#032f62}.hljs-built_in,.hljs-symbol{color:#e36209}.hljs-code,.hljs-comment,.hljs-formula{color:#6a737d}.hljs-name,.hljs-quote,.hljs-selector-pseudo,.hljs-selector-tag{color:#22863a}.hljs-subst{color:#24292e}.hljs-section{color:#005cc5;font-weight:700}.hljs-bullet{color:#735c0f}.hljs-emphasis{color:#24292e;font-style:italic}.hljs-strong{color:#24292e;font-weight:700}.hljs-addition{color:#22863a;background-color:#f0fff4}.hljs-deletion{color:#b31d28;background-color:#ffeef0}
doctum-theme/js/highlight.min.js
Vendored
+1213
View File
File diff suppressed because one or more lines are too long
doctum-theme/layout/base.twig
+22
View File
@@ -0,0 +1,22 @@
{% extends 'default/layout/base.twig' %}
{% block head %}
{{ parent() }}
<link rel="stylesheet" type="text/css" href="{{ path('css/highlight-github.min.css') }}">
<script defer src="{{ path('js/highlight.min.js') }}"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
document.querySelectorAll('pre.examples').forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
hljs.highlightElement(block);
});
});
</script>
{% endblock %}
doctum-theme/manifest.yml
+6
View File
@@ -0,0 +1,6 @@
name: phpredis
parent: default
static:
'css/highlight-github.min.css': 'css/highlight-github.min.css'
'js/highlight.min.js': 'js/highlight.min.js'
doctum.md
+5 -1
View File
@@ -5,4 +5,8 @@ curl -O https://doctum.long-term.support/releases/latest/doctum.phar
chmod +x doctum.phar
./doctum.phar update doctum-config.php
```
```
The build uses a custom Doctum theme stored in `doctum-theme/` so that extra
assets such as highlight.js are bundled with the generated HTML. Keep that
directory in sync if you ever update Doctum upstream assets.