Skip to content

Commit

Permalink
AUTOMATED: fetch new vuepress themes and plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Oct 16, 2023
1 parent e54a438 commit 6035db6
Show file tree
Hide file tree
Showing 53 changed files with 2,855 additions and 168 deletions.
33 changes: 28 additions & 5 deletions content/plugins/@celesta-vuepress-plugin-math.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
author:
avatar: null
avatar: https://avatars.githubusercontent.com/u/41458459?v=4
email: yuan.zx@outlook.com
name: Celeste
url: null
username: null
username: yzx9
bugs: https://github.com/nsznsznjsz/blog/issues
category: plugins
date: '2021-07-05T00:37:48.770Z'
Expand All @@ -13,7 +13,7 @@ description: KaTex support for vuepress
downloads: null
homepage: https://github.com/nsznsznjsz/blog#readme
keywords: null
license: null
license: MIT License
maintainers: null
name: '@celesta/vuepress-plugin-math'
npm: https://www.npmjs.com/package/%40celesta%2Fvuepress-plugin-math
Expand All @@ -25,10 +25,33 @@ publisher:
username: nsznsznjsz
repository: https://github.com/nsznsznjsz/blog
score: 0.5136961705198431
stars: 0
stars: 4
unstable: true
version: 0.5.0
watchers: 0
watchers: 4

---

### Hi there 👋

- 🌱 I’m studying for my master's degree on SHU
- 🤔 I’m currently learning English
- ⚡ Fun fact: Rendering in Computer Graphic

[![Celeste's github stats](https://github-readme-stats-yzx9.vercel.app/api/?username=yzx9&show_icons=true&hide_title=true)](https://github.com/anuraghazra/github-readme-stats)
[![Celeste's most used languages](https://github-readme-stats-yzx9.vercel.app/api/top-langs/?username=yzx9&layout=compact&exclude_repo=yzx9.github.io)](https://github.com/anuraghazra/github-readme-stats)

<!--
**yzx9/yzx9** is a ✨ _special_ ✨ repository because its `README.md` (this file) appears on your GitHub profile.
Here are some ideas to get you started:
- 🔭 I’m currently working on ...
- 🌱 I’m currently learning ...
- 👯 I’m looking to collaborate on ...
- 🤔 I’m looking for help with ...
- 💬 Ask me about ...
- 📫 How to reach me: ...
- 😄 Pronouns: ...
- ⚡ Fun fact: ...
-->
90 changes: 87 additions & 3 deletions content/plugins/@e8johan-vuepress-plugin-pdf-export.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
author:
avatar: null
avatar: https://avatars.githubusercontent.com/u/1732851?v=4
email: null
name: null
url: null
username: null
username: e8johan
bugs: https://github.com/e8johan/vuepress-plugin-pdf-export/issues
category: plugins
date: '2022-05-20T15:48:22.487Z'
Expand All @@ -13,7 +13,7 @@ description: Vuepress plugin for exporting site as PDF
downloads: null
homepage: https://github.com/e8johan/vuepress-plugin-pdf-export#readme
keywords: null
license: null
license: MIT License
maintainers: null
name: '@e8johan/vuepress-plugin-pdf-export'
npm: https://www.npmjs.com/package/%40e8johan%2Fvuepress-plugin-pdf-export
Expand All @@ -32,3 +32,87 @@ watchers: 0

---

# @e8johan/vuepress-plugin-pdf-export

Vuepress plugin for exporting site as PDF

This is a fork of @snowdog/vuepress-plugin-pdf-export. All changes are available in a PR to the upstream repository. Use this package at your own peril.

## Features
- Exports whole Vuepress based page as a single PDF file
- Applies styles to hide UI elements like navigation or sidebar
- Doesn't require other runtimes like Java to operate
- Designed to work well in headless environments like CI runners
- Can filter and sort pages.
- Can generate a rudimentary table of contents
- Can insert a front page (or front pages)

## Config options
- `theme` - theme name (default `@vuepress/default`)
- `sorter` - function for changing pages order (default `false`)
- `filter` - function for filtering the pages (default `false`)
- `tocLevel` - function returning a TOC level for the pages, i.e. zero or one (default `false`)
- `frontPage` - path to a pdf to inject first in the document. Typically a front page, but can be multiple pages too.
- `outputFileName` - name of output file (default `site.pdf`)
- `puppeteerLaunchOptions` - [Puppeteer launch options object](https://github.com/puppeteer/puppeteer/blob/v2.1.1/docs/api.md#puppeteerlaunchoptions) (default `{}`)
- `pageOptions` - [Puppeteer page formatting options object](https://github.com/puppeteer/puppeteer/blob/v2.1.1/docs/api.md#pagepdfoptions) (default `{format: 'A4'}`)

### Usage

Using this plugin:

``` js
// in .vuepress/config.js
module.exports = {
plugins: ['@snowdog/vuepress-plugin-pdf-export']
}
```

Then run:

``` bash
vuepress export [path/to/your/docs]
```

#### The filter function

The `filter` function takes a `pages` object and returns `true` or `false`. Only pages where the function returns `true` are rendered to the pdf. The function is invoked as follows:

```
exportPages = exportPages.filter(filter);
```

#### The sorter function

The `sorter` function takes two `pages` objects and return `-1`, `0`, or `1` to indicate the sort order. The function is invoked as follows:

```
exportPages = exportPages.sort(sorter)
```

The sorting happens after the filtering, so you only have to handle the pages that pass your filter function.

#### The tocLevel function

The `tocLevel` function takes a `pages` object returns a TOC level, either zero (`0`, top level) or one (`1`, secondary level), or minus one (`-1`, leave out of TOC). If the entire TOC is empty, e.g. every page is on level `-1`, no TOC is rendered.

The TOC generation is invoked after the filtering and sorting. So the list of pages can be assumed to be filtered.

### Tips
To run this plugin on Gitlab CI you may want to run Chrome with `no-sandbox` flag. [Details](https://github.com/puppeteer/puppeteer/blob/master/docs/troubleshooting.md#setting-up-chrome-linux-sandbox)

```js
module.exports = {
plugins: [
['@snowdog/vuepress-plugin-pdf-export', {
puppeteerLaunchOptions: {
args: ['--no-sandbox', '--disable-setuid-sandbox']
}
}]
]
}
```

## Known Issues

- At the moment, pdfjs cannot inject footers on the rendered pages, and the individual pages do not know their page number, so the page numbers in the TOC relates to the page numbers in the PDF, but no page number is rendered on the actual PDF pages.
76 changes: 71 additions & 5 deletions content/plugins/@panzhiyue-vuepress-plugin-demo-block.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
author:
avatar: null
avatar: https://avatars.githubusercontent.com/u/30484534?v=4
email: null
name: panzhiyue
url: null
username: null
username: panzhiyue
bugs: https://github.com/panzhiyue/vuepress-theme-knowledge/issues
category: plugins
date: '2022-06-14T02:41:44.885Z'
Expand All @@ -16,7 +16,7 @@ keywords:
- vuepress-plugin
- vuepress
- plugin
license: null
license: false
maintainers: null
name: '@panzhiyue/vuepress-plugin-demo-block'
npm: https://www.npmjs.com/package/%40panzhiyue%2Fvuepress-plugin-demo-block
Expand All @@ -28,10 +28,76 @@ publisher:
username: panzhiyue
repository: https://github.com/panzhiyue/vuepress-theme-knowledge
score: 0.5018260338908067
stars: 0
stars: 1
unstable: true
version: 1.0.0-beta.3
watchers: 0
watchers: 1

---

---
home: true
title: Home
heroImage: /images/hero.png
actions:
- text: Get Started
link: /guide/getting-started.html
type: primary
- text: Introduction
link: /guide/
type: secondary
features:
- title: Simplicity First
details: Minimal setup with markdown-centered project structure helps you focus on writing.
- title: Vue-Powered
details: Enjoy the dev experience of Vue, use Vue components in markdown, and develop custom themes with Vue.
- title: Performant
details: VuePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.
- title: Themes
details: Providing a default theme out of the box. You can also choose a community theme or create your own one.
- title: Plugins
details: Flexible plugin API, allowing plugins to provide lots of plug-and-play features for your site.
- title: Bundlers
details: Default bundler is Vite, while Webpack is also supported. Choose the one you like!
footer: MIT Licensed | Copyright © 2018-present Evan You
---

### As Easy as 1, 2, 3

<CodeGroup>
<CodeGroupItem title="YARN" active>

```bash
# install in your project
yarn add -D vuepress@next

# create a markdown file
echo '# Hello VuePress' > README.md

# start writing
yarn vuepress dev

# build to static files
yarn vuepress build
```

</CodeGroupItem>

<CodeGroupItem title="NPM">

```bash
# install in your project
npm install -D vuepress@next

# create a markdown file
echo '# Hello VuePress' > README.md

# start writing
npx vuepress dev

# build to static files
npx vuepress build
```

</CodeGroupItem>
</CodeGroup>
4 changes: 2 additions & 2 deletions content/plugins/@starzkg-vuepress-plugin-element-plus.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ publisher:
username: starzkg
repository: https://github.com/vuepress/vuepress-next
score: 0.5956441230359775
stars: 1919
stars: 1920
unstable: true
version: 1.0.0-beta.11
watchers: 1919
watchers: 1920

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ publisher:
username: starzkg
repository: https://github.com/vuepress/vuepress-next
score: 0.6132218109218953
stars: 1919
stars: 1920
unstable: true
version: 1.0.0-beta.13
watchers: 1919
watchers: 1920

---

Expand Down
68 changes: 63 additions & 5 deletions content/plugins/@starzkg-vuepress-plugin-pwa.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
author:
avatar: null
avatar: https://avatars.githubusercontent.com/u/96685951?v=4
email: shentuzhigang@shentuzhigang.cn
name: Starzkg
url: https://shentuzhigang.cn
username: null
username: vuepress-star
bugs: https://github.com/shentuzhigang/vuepress-theme-star/issues
category: plugins
date: '2021-12-25T17:58:23.078Z'
Expand All @@ -18,7 +18,7 @@ keywords:
- web app
- workbox
- service worker
license: null
license: MIT License
maintainers: null
name: '@starzkg/vuepress-plugin-pwa'
npm: https://www.npmjs.com/package/%40starzkg%2Fvuepress-plugin-pwa
Expand All @@ -30,10 +30,68 @@ publisher:
username: starzkg
repository: https://github.com/shentuzhigang/vuepress-theme-star
score: 0.48493669585183274
stars: 0
stars: 1
unstable: true
version: 1.0.0-beta.24
watchers: 0
watchers: 1

---


简体中文 | [English](README.en.md)

# vuepress-theme-star

vuepress:

[![github check](https://github.com/vuepress/vuepress-next/workflows/check/badge.svg)](https://github.com/vuepress/vuepress-next/actions?query=workflow%3Acheck)
[![github docs](https://github.com/vuepress/vuepress-next/workflows/docs/badge.svg)](https://github.com/vuepress/vuepress-next/actions?query=workflow%3Adocs)
[![npm](https://badgen.net/npm/v/vuepress/next)](https://www.npmjs.com/package/vuepress)
[![coverage](https://coveralls.io/repos/github/vuepress/vuepress-next/badge.svg?branch=main)](https://coveralls.io/github/vuepress/vuepress-next?branch=main)
[![license](https://badgen.net/github/license/vuepress/vuepress-next)](https://github.com/vuepress/vuepress-next/blob/main/LICENSE)
[![discord](https://badgen.net/discord/online-members/ptFjefy6H5?icon=discord&label=discord)](https://discord.gg/ptFjefy6H5)

vuepress-theme-star:

[![github check](https://github.com/vuepress-star/vuepress-theme-star/workflows/check/badge.svg)](https://github.com/vuepress-star/vuepress-theme-star/actions?query=workflow%3Acheck)
[![github docs](https://github.com/vuepress-star/vuepress-theme-star/workflows/docs/badge.svg)](https://github.com/vuepress-star/vuepress-theme-star/actions?query=workflow%3Adocs)
[![npm](https://badgen.net/npm/v/@starzkg/vuepress-theme-star/next)](https://www.npmjs.com/package/@starzkg/vuepress-theme-star)
[![coverage](https://coveralls.io/repos/github/vuepress-star/vuepress-theme-star/badge.svg?branch=main)](https://coveralls.io/github/vuepress-star/vuepress-theme-star?branch=main)
[![license](https://badgen.net/github/license/vuepress-star/vuepress-theme-star)](https://github.com/vuepress-star/vuepress-theme-star/blob/main/LICENSE)
[![discord](https://badgen.net/discord/online-members/ptFjefy6H5?icon=discord&label=discord)](https://discord.gg/ptFjefy6H5)

为了构建功能完备的个人网站 ✨

## star 用户数量 / 时间变化图

[![Stargazers over time](https://starchart.cc/vuepress-star/vuepress-theme-star.svg)](https://starchart.cc/vuepress-star/vuepress-theme-star)

## 状态: Beta

对于 VuePress v1 的用户,请查看 [迁移指南](https://v2.vuepress.vuejs.org/guide/migration.html)

对于想要关注我们的进展或为此项目做出贡献的用户,请查看 [roadmap](https://github.com/vuepress/vuepress-next/discussions/68)

![Alt](https://repobeats.axiom.co/api/embed/2827b1222a806940ade242aea985f0008bf8a7de.svg "Repobeats analytics image")

## 示例

https://vuepress-star.github.io/

## 文档

Vuepress: https://v2.vuepress.vuejs.org

Vuepress Theme Star: https://vuepress-star.github.io/docs/

## 联系

我们建议您联系使用问题和讨论。

## 贡献

See [Contributing Guide](https://github.com/vuepress-star/vuepress-theme-star/blob/main/docs/contributing.md).

## 许可

[MIT](https://github.com/vuepress-star/vuepress-theme-star/blob/main/LICENSE)
Loading

0 comments on commit 6035db6

Please sign in to comment.