diff --git a/.github/workflows/build_publish.yml b/.github/workflows/build_publish.yml index 83d9871..405b480 100644 --- a/.github/workflows/build_publish.yml +++ b/.github/workflows/build_publish.yml @@ -47,7 +47,7 @@ jobs: run: pnpm build - name: Upload Build Artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v4 with: name: build-dist path: | @@ -73,6 +73,7 @@ jobs: uses: actions/download-artifact@v4 with: name: build-dist + path: dist - name: Tagging env: @@ -92,7 +93,7 @@ jobs: with: tag_name: latest files: | - dist/* + dist/** draft: false - name: Trigger Netlify Rebuild diff --git a/README.md b/README.md index f50aebb..4ea3b7a 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ -# Artalk Distribution Resources +# Artalk Community Resources -This repository contains the distribution resources for the Artalk project, as well as our community plugins and themes. +[![Artalk](https://img.shields.io/badge/Artalk-Official-blue?style=flat-square)](https://artalk.js.org/) [![Releases](https://img.shields.io/github/release-date/ArtalkJS/Community?style=flat-square&label=Latest%20Updated)](https://github.com/ArtalkJS/Community/releases) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ArtalkJS/Community/build_publish.yml?style=flat-square&label=Build%20Status)](https://github.com/ArtalkJS/Community/actions) -Artalk is a open-source project that aims to provide a simple, fast and extensible commenting system for websites. You can easily create or install plugins and themes to customize the look and feel of your Artalk instance. A plugin guide is available in the [Artalk documentation](https://artalk.js.org/develop/plugin.html). +This repository contains the distribution resources for the [Artalk](https://github.com/ArtalkJS/Artalk) project, as well as our community plugins and themes. -The repo does not accept issues, if you han any questions or need help, please go to the [Artalk main repository](https://github.com/ArtalkJS/Artalk/issues). +Artalk is a open-source project that aims to provide a simple, fast and extensible commenting system for websites. You can easily create or install plugins and themes to customize the look and feel of your Artalk instance. A plugin guide is available in the [Documentation](https://artalk.js.org/develop/plugin.html). + +The repo does not accept issues, if you han any questions or need help, please go to the [Main Repository](https://github.com/ArtalkJS/Artalk/issues). ## Submit your plugin or theme Thanks for submitting your creations! We welcome all contributions to the Artalk ecosystem. -Before you start, make sure you have read the [Artalk plugin guide](https://artalk.js.org/develop/plugin.html) and [theme guide](https://artalk.js.org/develop/theme.html). +Before you start, make sure you have read the [Plugin Guide](https://artalk.js.org/develop/plugin.html) and [Theme Guide](https://artalk.js.org/develop/theme.html). Assuming you have already created your plugin or theme, and published it to [NPM](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry), you can now submit it to this repository. @@ -40,4 +42,4 @@ To submit your plugin or theme, please follow these steps: - After you updated the list, Artalk will automatically fetch the latest data from your `github_repo` and `npm_package` to get the information about your plugin or theme. - The `id` field is used to uniquely identify your plugin or theme. It should be a unique string that is not used by any other plugin or theme in this repository. - Your github plugin repository should contain a `README.md` file that describes your plugin or theme. This file will be displayed in the Artalk plugin or theme page. -- Your node repo should contain a `package.json` file, and managed by NPM. We provide [Artalk Vite plugin](https://www.npmjs.com/package/@artalk/plugin-kit) to help you build and keep your plugin or theme manifest information consistent with Artalk. A github repo template is available [here](https://github.com/ArtalkJS/artalk-plugin-sample), we recommend you to use it. +- Your node repo should contain a `package.json` file, and managed by NPM. We provide [Artalk Vite Plugin](https://www.npmjs.com/package/@artalk/plugin-kit) to help you build and keep your plugin or theme manifest information consistent with Artalk. A github repo template is available [here](https://github.com/ArtalkJS/artalk-plugin-sample), we recommend you to use it.