From 82cd62269945507c1101aa6c8984fc055456effd Mon Sep 17 00:00:00 2001 From: "Grigorii K. Shartsev" Date: Sun, 26 Jan 2025 16:31:35 +0100 Subject: [PATCH] chore(docs): add emoji Signed-off-by: Grigorii K. Shartsev --- README.md | 22 +++++++++++----------- docs/index.md | 14 +++++++------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 2099001d54..2078f6c46b 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ [![npm last version](https://img.shields.io/npm/v/@nextcloud/vue.svg?style=flat)](https://www.npmjs.com/package/@nextcloud/vue) [![Dependabot status](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg?longCache=true&style=flat&logo=dependabot)](https://dependabot.com) -> Nextcloud UI Kit for building Nextcloud apps with Vue +> πŸ–ΌοΈ Nextcloud UI Kit for building Nextcloud apps with Vue -- Standardized UI Components -- Composables and frontend utilities -- [Reference providers](https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/reference.html) utilities +- ✨ Standardized UI Components +- πŸ› οΈ Composables and frontend utilities +- πŸ”— [Reference providers](https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/reference.html) utilities -## Documentation +## πŸ“„ Documentation | Version | Target | Documentation | |----------------|-----------------------|-------------------------------------------------------| @@ -24,13 +24,13 @@ | v7.x [stable7] | Nextcloud 25 - 27 | https://stable7--nextcloud-vue-components.netlify.app | | v6.x [stable6] | Nextcloud 24 - 25 | https://stable6--nextcloud-vue-components.netlify.app | -## Install +## πŸ“¦ Install ```bash npm i @nextcloud/vue ``` -## Usage +## πŸš€ Usage Import corresponding components and other modules on use. Check the documentation for more details. @@ -63,7 +63,7 @@ import { NextcloudVuePlugin } from '@nextcloud/vue' Vue.use(NextcloudVuePlugin) ``` -## Development setup +## πŸ§‘β€πŸ’» Development setup If you want to work on improving the components it’s best to run the latest code and link it to your local Nextcloud installation: @@ -77,7 +77,7 @@ If you want to work on improving the components it’s best to run the latest co - In the repository of an app do `npm link @nextcloud/vue` (you need to re-link any time you do `npm ci` in the app) 4. Then build the app with: `npm run build` (or watch for changes with `npm run watch`) -## Translations +## 🌐 Translations Use `t` and `n` functions imported from `@nextcloud/l10n` to display translated strings. @@ -102,7 +102,7 @@ Our awesome translation community will then be notified and a bot will sync tran npm run l10n:extract ``` -## Styleguide +## 🐸 Styleguide When developing new components or extending components, make sure to also have some bits of related documentation like examples, where applicable. To test components and the documentation in that context, you can run `npm run styleguide` to run a local server that serves the style guide @@ -134,7 +134,7 @@ index 0e3a6a705d..416b8b0fb9 100644 /** @var array Domains from which scripts can get loaded */ ``` -## Releasing a new version +## πŸ“€ Releasing a new version - Pull the latest changes from `master` or `stableX` - Checkout a new branch with the tag name (e.g `v4.0.1`): `git checkout -b v` diff --git a/docs/index.md b/docs/index.md index ad52e29af5..a6c0e12534 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,13 +9,13 @@ - SPDX-License-Identifier: AGPL-3.0-or-later --> -> Nextcloud UI Kit for building Nextcloud apps with Vue +> πŸ–ΌοΈ Nextcloud UI Kit for building Nextcloud apps with Vue -- Standardized UI Components -- Composables and frontend utilities -- [Reference providers](https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/reference.html) utilities +- ✨ Standardized UI Components +- πŸ› οΈ Composables and frontend utilities +- πŸ”— [Reference providers](https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/reference.html) utilities -## Documentation +## πŸ“„ Documentation | Version | Target | Documentation | |----------------|-----------------------|-------------------------------------------------------| @@ -24,13 +24,13 @@ | v7.x [stable7] | Nextcloud 25 - 27 | https://stable7--nextcloud-vue-components.netlify.app | | v6.x [stable6] | Nextcloud 24 - 25 | https://stable6--nextcloud-vue-components.netlify.app | -## Install +## πŸ“¦ Install ```bash npm i @nextcloud/vue ``` -## Usage +## πŸš€ Usage Import corresponding components and other modules on use. Check the documentation for more details.