jointrashposs/README.md

91 lines
1.6 KiB
Markdown
Raw Normal View History

2023-11-11 17:03:19 +01:00
# Misskey Hub (Next)
2023-07-08 10:36:02 +02:00
2023-11-11 17:02:25 +01:00
![Screenshot of Misskey Hub](./public/img/og/misskey-hub-screenshot-dr.png)
2023-07-08 10:36:02 +02:00
2023-11-11 17:02:25 +01:00
Website for Misskey, built with [Nuxt](https://nuxt.com/).
2023-07-08 10:36:02 +02:00
2023-11-11 17:02:25 +01:00
Release date: **TBD未定**
2023-11-11 13:03:15 +01:00
2023-09-24 12:43:14 +02:00
## お知らせの文言のいじり方
2023-11-11 13:03:15 +01:00
`app.config.ts` から指定できます。
## Docsの書き方
2023-12-01 13:59:27 +01:00
**必ず [`/content/.README.md`](./content/.README.md) をご覧ください**
2023-09-24 12:43:14 +02:00
## NuxtLinkについて
2023-12-01 13:59:27 +01:00
内部リンク・外部リンクに関する処理を強化した[`<GNuxtLink>`](./components/g/NuxtLink.vue)を使用していますので、**リンクを追加する際は`<NuxtLink>`ではなく`<GNuxtLink>`を使用してください。**
### Misskey Webへのリンクについて
GNuxtLinkおよび各種Docsで、アドレスに `x-mi-web://` から始め、続けてMisskeyの相対パスを入力すると、Misskey Webへのリンクに置き換えられます。
例: `/play``x-mi-web://play`
2023-07-08 10:36:02 +02:00
## Setup
Make sure to install the dependencies:
```bash
# npm
npm install
# pnpm
pnpm install
# yarn
yarn install
```
## Development Server
Start the development server on `http://localhost:3000`:
```bash
# npm
npm run dev
# pnpm
pnpm run dev
# yarn
yarn dev
```
## Production
Build the application for production:
```bash
# npm
npm run build
# pnpm
pnpm run build
# yarn
yarn build
```
Locally preview production build:
```bash
# npm
npm run preview
# pnpm
pnpm run preview
# yarn
yarn preview
```
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
2023-11-11 13:03:15 +01:00
## License
GNU Affero General Public License v3.0
(c) 2023 Misskey, syuilo, kakkokari-gtyih and other contributors