зеркало из https://github.com/nextcloud/cookbook.git
74 строки
4.0 KiB
Markdown
74 строки
4.0 KiB
Markdown
<div align="center">
|
|
|
|
<img src="docs/assets/icon256x256.png#gh-dark-mode-only" alt="Nextcloud Cookbook icon" width="100"/>
|
|
<img src="docs/assets/icon256x256-dark.png#gh-light-mode-only" alt="Nextcloud Cookbook icon" width="100"/>
|
|
|
|
# Nextcloud Cookbook
|
|
|
|
</div>
|
|
|
|
<div align="center">
|
|
<a href="https://matrix.to/#/#nextcloud-cookbook:matrix.org" >
|
|
<img src="https://img.shields.io/matrix/nextcloud-cookbook:matrix.org?logo=matrix&label=Join%20the%20discussion&style=flat" alt="Join us on Matrix" >
|
|
</a>
|
|
|
|
|
|
[](https://codecov.io/gh/nextcloud/cookbook)
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<p style="text-align:center;">
|
|
<img alt="A screenshot of how the app looks" src="./docs/assets/screenshot.png" width="900">
|
|
</p>
|
|
A library for all your recipes. It uses JSON files following the schema.org recipe format. To add a recipe to the collection, you can paste in the URL of the recipe, and the provided web page will be parsed and downloaded to whichever folder you specify in the app settings.
|
|
|
|
|
|
## 📱 Clients
|
|
|
|
The app works generally in any modern browser. Additionally, there are some more specialized clients available, including mobile apps for Android and iOS. You can find an overview [here](docs/user/clients/Index.md).
|
|
|
|
## 📖 Documentation
|
|
Further documentation (also internal ones) are published on the [documentation pages of the project](http://nextcloud.github.io/cookbook/) and in the FAQ at the bottom.
|
|
|
|
|
|
## 💼 Is it Production Ready?
|
|
|
|
> [!WARNING]
|
|
> Users of this app are practically testers. We're limited on resources and still working out how to make this app function the best it can. There will be regressions and bugs. And we of course appreciate constructive feedback whenever users run into them.
|
|
|
|
## 💰 Sponsoring
|
|
|
|
We thank the sponsors of this project for their support as open-source software.
|
|
|
|
[<img alt="Blackfire Logo" src=".img/blackfire-io.png" style="height: 40px;">](https://www.blackfire.io) [<img alt="Browserstack Logo" src=".img/BrowserStack.png" style="height: 40px;">](https://www.browserstack.com/)
|
|
|
|
## 🧑🏫 F.A.Q.
|
|
|
|
<details>
|
|
<summary><b>I can't see my recipes</b></summary>
|
|
|
|
Recipes are only shown in the UI if they are present in the database. It is likely you have recipes that haven't been indexed/added to the database yet. Try clicking the Settings > Rescan library button to compare the database with what is in your recipes folder and apply any differences to the database.
|
|
|
|
If this still doesn't work, a full, non-incremental resync might help. This can be done by setting your recipes folder to a different (ideally empty) folder to clear the database. Setting the recipes folder back to what it was before should cause all your recipes to sync again, effectively refreshing the database.
|
|
</details>
|
|
|
|
<details>
|
|
<summary><b>"Could not load recipe" when trying to download recipes?</b></summary>
|
|
|
|
A lot of websites are unfortunately not following the schema.org/Recipe standard, which makes their recipes impossible to read by this app.
|
|
</details>
|
|
|
|
<details>
|
|
<summary><b>A website using correct schema.org markup is not being read correctly</b></summary>
|
|
The parser is far from perfect. If you can help out in any way, please [have a look at the parseRecipeHtml() method](https://github.com/nextcloud/nextcloud-cookbook/blob/master/lib/Service/RecipeService.php) and create a pull request with your changes.
|
|
</details>
|
|
|
|
<details>
|
|
<summary><b>All of the text is in English?</b></summary>
|
|
This app uses the [Transifex](https://app.transifex.com/nextcloud/nextcloud/cookbook/) translation system.
|
|
You might want to register there to help translating the app to new languages or report errors in existing translations.
|
|
</details>
|