docs: add example documents and preview PDF links to documentation

isomoes · isomoes · commit 83cab9a7508c · 2025-04-02T11:29:44.000+08:00
diff --git a/docs/README.md b/docs/README.md
@@ -32,3 +32,7 @@ This project includes support for:
 - **Chinese documents** - See the `zh/` directory for templates
 
 Each language has its own style files and examples to help you get started.
+
+## Preview PDF Examples
+
+You can preview example PDF output files without having to compile them yourself by visiting the [GitHub Releases page](https://github.com/jiahaoxiang2000/typesetting/releases). There you'll find pre-compiled PDF examples of reports, notes, slides and other document types in both supported languages.
diff --git a/docs/examples.md b/docs/examples.md
@@ -0,0 +1,35 @@
+# Example Documents
+
+This page showcases example documents created with our LaTeX typesetting system. You can view these PDF files directly in your browser.
+
+## Chinese Documents
+
+### Note Template
+
+This is an example of a note document created with the Chinese note template.
+
+[PDF Embed](https://github.com/jiahaoxiang2000/typesetting/releases/download/v0.3.4/note-zh.pdf ":pdf")
+
+### Report Template
+
+This is an example of a report document created with the Chinese report template.
+
+[PDF Embed](https://github.com/jiahaoxiang2000/typesetting/releases/download/v0.3.4/report-zh.pdf ":pdf")
+
+### Slide Template
+
+This is an example of a presentation slide created with the Chinese slide template.
+
+[PDF Embed](https://github.com/jiahaoxiang2000/typesetting/releases/download/v0.3.4/slide-zh.pdf ":pdf")
+
+## English Documents
+
+### Report Template
+
+This is an example of a report document created with the English report template.
+
+[PDF Embed](https://github.com/jiahaoxiang2000/typesetting/releases/download/v0.3.4/report-en.pdf ":pdf")
+
+---
+
+> **Note:** You can also download all example PDFs directly from our [GitHub Releases page](https://github.com/jiahaoxiang2000/typesetting/releases).
diff --git a/docs/index.html b/docs/index.html
@@ -7,6 +7,8 @@
   <meta name="description" content="Documentation for the LaTeX Typesetting Project">
   <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
   <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+  <!-- PDF.js stylesheet -->
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/pdfjs-dist@2.9.359/web/pdf_viewer.min.css">
 </head>
 <body>
   <div id="app"></div>
@@ -34,6 +36,14 @@
         buttonText: 'Copy to clipboard',
         errorText: 'Error',
         successText: 'Copied'
+      },
+      // PDF embed configuration
+      pdf: {
+        // PDF.js options
+        pdfOptions: {
+          height: "800px",
+          width: "100%"
+        }
       }
     }
   </script>
@@ -46,5 +56,10 @@
   <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-latex.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-tex.min.js"></script>
+  
+  <!-- PDF.js requirements -->
+  <script src="//cdn.jsdelivr.net/npm/pdfjs-dist@2.9.359/build/pdf.min.js"></script>
+  <!-- PDF.js for Docsify plugin -->
+  <script src="//cdn.jsdelivr.net/npm/docsify-pdf-embed-plugin/dist/docsify-pdf-embed.js"></script>
 </body>
 </html>
diff --git a/docs/sidebar.md b/docs/sidebar.md
@@ -2,4 +2,5 @@
 - [Getting Started](getting-started.md)
 - [Usage Guide](usage.md)
 - [Templates](templates.md)
+- [Examples](examples.md)
 - [Contributing](contributing.md)
diff --git a/readme.md b/readme.md
@@ -43,6 +43,10 @@ This project provides tools and templates for high-quality document typesetting
 
 Check out our [online documentation](https://jiahaoxiang2000.github.io/typesetting/) for detailed usage instructions.
 
+## Preview Examples
+
+You can view example PDF files without having to compile them yourself by visiting our [GitHub Releases page](https://github.com/jiahaoxiang2000/typesetting/releases), where you'll find pre-compiled PDF examples of various document types.
+
 ## Directory Structure
 
 ```
