Skip to content

Commit 8de8ec0

Browse files
xixu-mexixu-me
committed
Add social media metadata to documentation
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.
1 parent 6c48d80 commit 8de8ec0

File tree

10 files changed

+50
-7
lines changed

10 files changed

+50
-7
lines changed

‎docs/404.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ myst:
77
og:description: "The requested page could not be found. Visit the tzst documentation homepage or use the search feature."
88
twitter:title: "Page Not Found - tzst Documentation"
99
twitter:description: "The requested page could not be found. Visit the tzst documentation homepage or use the search feature."
10+
og:type: "website"
11+
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
12+
og:url: "https://tzst.xi-xu.me/"
13+
twitter:card: "summary_large_image"
14+
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
1015
---
1116

1217
# 404 - Page Not Found

‎docs/_static/tzst-square-logo.png

1.34 MB
Loading

‎docs/api/cli.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ myst:
77
og:description: "CLI API documentation for tzst - Command-line interface functions and utilities"
88
twitter:title: "tzst CLI API Reference"
99
twitter:description: "CLI API documentation for tzst - Command-line interface functions and utilities"
10+
og:type: "website"
11+
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
12+
og:url: "https://tzst.xi-xu.me/"
13+
twitter:card: "summary_large_image"
14+
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
1015
---
1116

1217
# CLI API

‎docs/api/core.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ myst:
77
og:description: "Core API documentation for tzst - TzstArchive class and convenience functions"
88
twitter:title: "tzst Core API Reference"
99
twitter:description: "Core API documentation for tzst - TzstArchive class and convenience functions"
10+
og:type: "website"
11+
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
12+
og:url: "https://tzst.xi-xu.me/"
13+
twitter:card: "summary_large_image"
14+
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
1015
---
1116

1217
# Core API

‎docs/api/exceptions.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@ myst:
33
html_meta:
44
description: "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
55
keywords: "tzst exceptions, Python exceptions, error handling, TzstError, TzstArchiveError, archive errors, compression errors"
6-
"og:title": "tzst Exceptions API Reference"
7-
"og:description": "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
8-
"og:type": "article"
9-
"twitter:title": "tzst Exceptions API Reference"
10-
"twitter:description": "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
11-
"article:section": "API Reference"
12-
"article:tag": "exceptions, error handling, API"
6+
og:title: "tzst Exceptions API Reference"
7+
og:description: "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
8+
og:type: "article"
9+
twitter:title: "tzst Exceptions API Reference"
10+
twitter:description: "Complete reference for tzst exception classes and error handling. Learn about TzstError, TzstArchiveError, and other custom exceptions for robust archive operations."
11+
og:type: "website"
12+
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
13+
og:url: "https://tzst.xi-xu.me/"
14+
twitter:card: "summary_large_image"
15+
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
1316
---
1417

1518
# Exceptions API

‎docs/api/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ myst:
77
og:description: "Complete API reference for tzst - Core functions, CLI tools, and exception handling"
88
twitter:title: "tzst API Reference"
99
twitter:description: "Complete API reference for tzst - Core functions, CLI tools, and exception handling"
10+
og:type: "website"
11+
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
12+
og:url: "https://tzst.xi-xu.me/"
13+
twitter:card: "summary_large_image"
14+
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
1015
---
1116

1217
# API Reference

‎docs/examples.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ myst:
77
og:description: "Comprehensive examples for tzst - archive creation, extraction, security, and performance optimization"
88
twitter:title: "tzst Examples and Tutorials"
99
twitter:description: "Comprehensive examples for tzst - archive creation, extraction, security, and performance optimization"
10+
og:type: "website"
11+
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
12+
og:url: "https://tzst.xi-xu.me/"
13+
twitter:card: "summary_large_image"
14+
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
1015
---
1116

1217
# Examples

‎docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ myst:
77
og:description: "Fast, secure, and reliable Python library for tar.zst archives with Zstandard compression"
88
twitter:title: "tzst - Next-Generation Archive Management"
99
twitter:description: "Fast, secure, and reliable Python library for tar.zst archives with Zstandard compression"
10+
og:type: "website"
11+
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
12+
og:url: "https://tzst.xi-xu.me/"
13+
twitter:card: "summary_large_image"
14+
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
1015
---
1116

1217
# tzst Documentation

‎docs/performance.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ myst:
77
og:description: "Performance optimization tips and comparison with other archive tools for tzst"
88
twitter:title: "tzst Performance Guide"
99
twitter:description: "Performance optimization tips and comparison with other archive tools for tzst"
10+
og:type: "website"
11+
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
12+
og:url: "https://tzst.xi-xu.me/"
13+
twitter:card: "summary_large_image"
14+
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
1015
---
1116

1217
# Performance Guide

‎docs/quickstart.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ myst:
77
og:description: "Learn how to install and use tzst for Python tar.zst archive management in minutes"
88
twitter:title: "tzst Quick Start Guide"
99
twitter:description: "Learn how to install and use tzst for Python tar.zst archive management in minutes"
10+
og:type: "website"
11+
og:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
12+
og:url: "https://tzst.xi-xu.me/"
13+
twitter:card: "summary_large_image"
14+
twitter:image: "https://tzst.xi-xu.me/_static/tzst-square-logo.png"
1015
---
1116

1217
# Quick Start Guide

0 commit comments

Comments
 (0)