An open API service indexing awesome lists of open source software.

https://github.com/cssnr/vitepress-swiper-docs

Documentation for @cssnr/vitepress-swiper VitePress Plugin
https://github.com/cssnr/vitepress-swiper-docs

Last synced: 9 months ago
JSON representation

Documentation for @cssnr/vitepress-swiper VitePress Plugin

Awesome Lists containing this project

README

          

[![Pages](https://img.shields.io/github/actions/workflow/status/cssnr/vitepress-swiper-docs/pages.yaml?logo=github&label=pages)](https://github.com/cssnr/vitepress-swiper-docs/actions/workflows/pages.yaml)
[![Lint](https://img.shields.io/github/actions/workflow/status/cssnr/vitepress-swiper-docs/lint.yaml?logo=github&label=lint)](https://github.com/cssnr/vitepress-swiper-docs/actions/workflows/lint.yaml)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/vitepress-swiper-docs?logo=vitepress&logoColor=white&label=updated)](https://github.com/cssnr/vitepress-swiper-docs/pulse)
[![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/vitepress-swiper-docs?logo=bookstack&logoColor=white&label=repo%20size)](https://github.com/cssnr/vitepress-swiper-docs)
[![NPM Version](https://img.shields.io/npm/v/%40cssnr%2Fvitepress-swiper?logo=npm)](https://www.npmjs.com/package/@cssnr/vitepress-swiper)
[![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/vitepress-swiper?logo=github)](https://github.com/cssnr/vitepress-swiper/discussions)
[![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/vitepress-swiper?style=flat&logo=github)](https://github.com/cssnr/vitepress-swiper)
[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=github&label=org%20stars)](https://cssnr.github.io/)
[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/wXy6m2X8wY)
[![Ko-fi](https://img.shields.io/badge/Ko--fi-72a5f2?logo=kofi&label=support)](https://ko-fi.com/cssnr)

# VitePress Swiper Plugin Documentation

Documentation for the [VitePress Swiper](https://github.com/cssnr/vitepress-swiper) Plugin.

- https://vitepress-swiper.cssnr.com/

These [docs](docs) are **written in plain text** using Markdown and built with [VitePress](https://vitepress.dev/).

| Location | Description |
| ---------------------------------------------- | ------------------------------------ |
| [docs](docs) | Documentation Root (Markdown files). |
| [docs/public](docs/public) | Static Root (copied to docs root). |
| [.vitepress](.vitepress) | VitePress Configuration Root. |
| [.vitepress/config.mts](.vitepress/config.mts) | VitePress Configuration File. |

## Development

To get started, clone the repository and run `npm i` then `npm run dev`.

```shell
npm install
npm run dev
```

The site should now be available at: http://localhost:5173/

- [VitePress CLI Reference](https://vitepress.dev/reference/cli)
- [VitePress Markdown Reference](https://vitepress.dev/guide/markdown)

# Contributing

For instructions on modifying the documentation see the [CONTRIBUTING.md](https://github.com/cssnr/.github/blob/master/.github/CONTRIBUTING.md).

Please consider making a donation to support the development of this project
and [additional](https://cssnr.com/) open source projects.

[![Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/cssnr)

For a full list of current projects visit: [https://cssnr.github.io/](https://cssnr.github.io/)