Skip to content

Commit

Permalink
chore(docs): add emoji
Browse files Browse the repository at this point in the history
Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
  • Loading branch information
ShGKme committed Jan 26, 2025
1 parent 683ed33 commit 82cd622
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|----------------|-----------------------|-------------------------------------------------------|
Expand All @@ -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.

Expand Down Expand Up @@ -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:

Expand All @@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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<version>`
Expand Down
14 changes: 7 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|----------------|-----------------------|-------------------------------------------------------|
Expand All @@ -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.

Expand Down

0 comments on commit 82cd622

Please sign in to comment.