Skip to content

Commit

Permalink
Migrate from vuepress to vitepress
Browse files Browse the repository at this point in the history
  • Loading branch information
lneugebauer committed May 11, 2024
1 parent 404753f commit 6b73838
Show file tree
Hide file tree
Showing 15 changed files with 1,491 additions and 4,476 deletions.
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,8 @@ lint/tmp/
ehthumbs.db
Thumbs.db

# VuePress
.cache/
.temp/
dist/
# VitePress
docs/**/cache/
docs/**/dist/
docs/.idea
node_modules/
33 changes: 33 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import {defineConfig} from 'vitepress'

export default defineConfig({
base: '/nextcloud-cookbook/',
title: 'Nextcloud Cookbook',
description: 'An Android client for Nextcloud Cookbook app.',
head: [
['meta', {name: 'google-site-verification', content: 'aSKiI82xCweR2wlBpOe7lJnKVLLBUVU5ZIRCeRcd0xo'}],
['link', {rel: 'icon', href: '/nextcloud-cookbook/images/logo.png'}],
['script', {
async: '',
src: 'https://umami.lukneu.de/script.js',
'data-website-id': '7242c1c7-b33a-4caa-ad52-3c1f461d4e34'
}]
],
sitemap: {
hostname: 'https://lneugebauer.github.io/nextcloud-cookbook/'
},
lastUpdated: true,
themeConfig: {
nav: [
{text: 'Home', link: '/'},
{text: 'Contributing', link: '/contributing'}
],
logo: './assets/images/logo.png',
socialLinks: [
{icon: 'github', link: 'https://github.com/lneugebauer/nextcloud-cookbook'}
],
footer: {
message: 'Released under the <a href="https://github.com/lneugebauer/nextcloud-cookbook/blob/main/LICENSE">MIT License</a>.'
},
}
})
36 changes: 0 additions & 36 deletions docs/.vuepress/config.ts

This file was deleted.

54 changes: 0 additions & 54 deletions docs/README.md

This file was deleted.

File renamed without changes
File renamed without changes
File renamed without changes
31 changes: 31 additions & 0 deletions docs/components/NCBadge.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<script setup lang="ts">
import {defineProps} from 'vue'
import type {NCBadge} from "./types.js";
interface Props {
badge: NCBadge
size: 'small' | 'medium'
}
const props = defineProps<Props>()
</script>

<template>
<a :href="badge.link">
<img class="badge" :class="[size]" :src="badge.src" :alt="badge.alt"/>
</a>
</template>

<style scoped>
.badge {
width: auto;
}
.medium {
height: 80px;
}
.small {
height: 30px;
}
</style>
26 changes: 26 additions & 0 deletions docs/components/NCDonationBadges.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<script setup lang="ts">
import {defineProps} from 'vue'
import type {NCBadge} from "./types";
import NCBadgeComponent from "./NCBadge.vue"
interface Props {
badges: NCBadge[]
}
const props = defineProps<Props>()
</script>

<template>
<div class="container">
<NCBadgeComponent v-for="badge in badges" :key="badge.link" :badge="badge" size="small"/>
</div>
</template>

<style scoped>
.container {
display: flex;
flex-wrap: wrap;
height: 30px;
gap: 15px;
}
</style>
24 changes: 24 additions & 0 deletions docs/components/NCStoreBadges.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<script setup lang="ts">
import {defineProps} from 'vue'
import type {NCBadge} from "./types";
import NCBadgeComponent from "./NCBadge.vue"
interface Props {
badges: NCBadge[]
}
const props = defineProps<Props>()
</script>

<template>
<div class="container">
<NCBadgeComponent v-for="badge in badges" :key="badge.link" :badge="badge" size="medium"/>
</div>
</template>

<style scoped>
.container {
display: flex;
flex-wrap: wrap;
}
</style>
5 changes: 5 additions & 0 deletions docs/components/types.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export interface NCBadge {
alt: string
link: string
src: string
}
84 changes: 84 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
layout: home

hero:
name: Nextcloud Cookbook
text: A native Android client
tagline: Browse your recipes with ease.
image:
src: ./assets/images/logo.png
actions:
- theme: brand
text: Help translating
link: /contributing#translations
- theme: alt
text: View on GitHub
link: https://github.com/lneugebauer/nextcloud-cookbook
---

<script setup lang="ts">
import NCDonationBadges from './components/NCDonationBadges.vue';
import NCStoreBadges from './components/NCStoreBadges.vue';

const storeBadges = [
{
alt: 'Get it on Play Store',
link: 'https://play.google.com/store/apps/details?id=de.lukasneugebauer.nextcloudcookbook',
src: 'https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png'
}, {
alt: 'Get it on GitHub',
link: 'https://github.com/lneugebauer/nextcloud-cookbook/releases',
src: './assets/images/get_it_on_github.png'
}, {
alt: 'Get it on F-Droid',
link: 'https://f-droid.org/packages/de.lukasneugebauer.nextcloudcookbook/',
src: 'https://fdroid.gitlab.io/artwork/badge/get-it-on.png'
}
];

const donationBadges = [
{
alt: 'Donate using Liberapay',
link: 'https://liberapay.com/lneugebauer/donate',
src: 'https://liberapay.com/assets/widgets/donate.svg'
}, {
alt: 'Donate using PayPal',
link: 'https://www.paypal.com/donate/?hosted_button_id=ECDNN8PS3SSMQ',
src: './assets/images/donate_with_paypal.svg'
}
];
</script>

## Download

<NCStoreBadges :badges="storeBadges" />

## Features :rocket:

- List all recipes
- List all recipes by category
- Create recipe
- View recipe
- Edit recipe
- Stay awake on recipe screen
- Settings

## Planned features :checkered_flag:

- Offline usage
- Single Sign On through Nextcloud Files app
- Login via QR-Code
- Import recipe via url

## Donate

<NCDonationBadges :badges="donationBadges" />

## Translations :earth_africa:

[![Translation status](https://hosted.weblate.org/widget/nextcloud-cookbook/287x66-grey.png)](https://hosted.weblate.org/engage/nextcloud-cookbook/)

## Requirements :link:

* [Nextcloud](https://nextcloud.com/) instance running
* [Nextcloud Cookbook](https://github.com/nextcloud/cookbook) app enabled
File renamed without changes.
Loading

0 comments on commit 6b73838

Please sign in to comment.