xixu-me/tzst
1
0 Fork 0
Code Issues Pull Requests Actions 7 Packages Projects Releases Wiki Activity

Add social media metadata to documentation

Browse Source 
Updated multiple documentation files to include Open Graph and Twitter metadata for better social media sharing. Added a new logo image to the static assets folder and referenced it in the metadata.
This commit is contained in:
xixu-me committed 2025-06-06 22:15:54 +08:00
1 parent 6c48d80d9a
commit 8de8ec0356
10 files changed
+50 -7
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/404.md
+5
View File
@@ -7,6 +7,11 @@ myst:
og:description: "The requested page could not be found. Visit the tzst documentation homepage or use the search feature."
twitter:title: "Page Not Found - tzst Documentation"
twitter:description: "The requested page could not be found. Visit the tzst documentation homepage or use the search feature."
og:type: "website"
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
og:url: "https://tzst.xi-xu.me/"
twitter:card: "summary_large_image"
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
---
# 404 - Page Not Found
docs/_static/tzst-square-logo.png
Vendored
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.3 MiB

docs/api/cli.md
+5
View File
@@ -7,6 +7,11 @@ myst:
og:description: "CLI API documentation for tzst - Command-line interface functions and utilities"
twitter:title: "tzst CLI API Reference"
twitter:description: "CLI API documentation for tzst - Command-line interface functions and utilities"
og:type: "website"
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
og:url: "https://tzst.xi-xu.me/"
twitter:card: "summary_large_image"
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
---
# CLI API
docs/api/core.md
+5
View File
@@ -7,6 +7,11 @@ myst:
og:description: "Core API documentation for tzst - TzstArchive class and convenience functions"
twitter:title: "tzst Core API Reference"
twitter:description: "Core API documentation for tzst - TzstArchive class and convenience functions"
og:type: "website"
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
og:url: "https://tzst.xi-xu.me/"
twitter:card: "summary_large_image"
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
---
# Core API
docs/api/exceptions.md
+10 -7
View File
@@ -3,13 +3,16 @@ myst:
html_meta:
description: "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
keywords: "tzst exceptions, Python exceptions, error handling, TzstError, TzstArchiveError, archive errors, compression errors"
"og:title": "tzst Exceptions API Reference"
"og:description": "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
"og:type": "article"
"twitter:title": "tzst Exceptions API Reference"
"twitter:description": "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
"article:section": "API Reference"
"article:tag": "exceptions, error handling, API"
og:title: "tzst Exceptions API Reference"
og:description: "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
og:type: "article"
twitter:title: "tzst Exceptions API Reference"
twitter:description: "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
og:type: "website"
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
og:url: "https://tzst.xi-xu.me/"
twitter:card: "summary_large_image"
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
---
# Exceptions API
docs/api/index.md
+5
View File
@@ -7,6 +7,11 @@ myst:
og:description: "Complete API reference for tzst - Core functions, CLI tools, and exception handling"
twitter:title: "tzst API Reference"
twitter:description: "Complete API reference for tzst - Core functions, CLI tools, and exception handling"
og:type: "website"
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
og:url: "https://tzst.xi-xu.me/"
twitter:card: "summary_large_image"
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
---
# API Reference
docs/examples.md
+5
View File
@@ -7,6 +7,11 @@ myst:
og:description: "Comprehensive examples for tzst - archive creation, extraction, security, and performance optimization"
twitter:title: "tzst Examples and Tutorials"
twitter:description: "Comprehensive examples for tzst - archive creation, extraction, security, and performance optimization"
og:type: "website"
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
og:url: "https://tzst.xi-xu.me/"
twitter:card: "summary_large_image"
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
---
# Examples
docs/index.md
+5
View File
@@ -7,6 +7,11 @@ myst:
og:description: "Fast, secure, and reliable Python library for tar.zst archives with Zstandard compression"
twitter:title: "tzst - Next-Generation Archive Management"
twitter:description: "Fast, secure, and reliable Python library for tar.zst archives with Zstandard compression"
og:type: "website"
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
og:url: "https://tzst.xi-xu.me/"
twitter:card: "summary_large_image"
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
---
# tzst Documentation
docs/performance.md
+5
View File
@@ -7,6 +7,11 @@ myst:
og:description: "Performance optimization tips and comparison with other archive tools for tzst"
twitter:title: "tzst Performance Guide"
twitter:description: "Performance optimization tips and comparison with other archive tools for tzst"
og:type: "website"
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
og:url: "https://tzst.xi-xu.me/"
twitter:card: "summary_large_image"
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
---
# Performance Guide
docs/quickstart.md
+5
View File
@@ -7,6 +7,11 @@ myst:
og:description: "Learn how to install and use tzst for Python tar.zst archive management in minutes"
twitter:title: "tzst Quick Start Guide"
twitter:description: "Learn how to install and use tzst for Python tar.zst archive management in minutes"
og:type: "website"
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
og:url: "https://tzst.xi-xu.me/"
twitter:card: "summary_large_image"
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
---
# Quick Start Guide