mirror of
https://github.com/YunoHost-Apps/silverbullet_ynh.git
synced 2024-09-03 20:26:18 +02:00
update READMEs
This commit is contained in:
parent
f4aa357189
commit
817ef3bb24
2 changed files with 41 additions and 5 deletions
24
README.md
24
README.md
|
@ -9,14 +9,32 @@ It shall NOT be edited by hand.
|
||||||
|
|
||||||
[![Install SilverBullet with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=silverbullet)
|
[![Install SilverBullet with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=silverbullet)
|
||||||
|
|
||||||
_[Lire ce readme en français.](./README_fr.md)_
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
> *This package allows you to install SilverBullet quickly and simply on a YunoHost server.
|
> *This package allows you to install SilverBullet quickly and simply on a YunoHost server.
|
||||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
This is a dummy description of this app features
|
SilverBullet aims to be your workshop for the mind: a creative space where you collect, create and expand your personal knowledge, while also letting you constantly evolve the tools you use to do so.
|
||||||
|
|
||||||
|
While you can use SilverBullet as a simple note taking application that stores notes in plain markdown files on disk, it becomes truly powerful in the hands of more technical power users. By leveraging metadata annotations, its Objects infrastructure, Live Queries and Live Templates, SilverBullet becomes a powerful end-user programming tool, enabling you to quickly develop various types of ad-hoc knowledge applications.
|
||||||
|
|
||||||
|
# Features
|
||||||
|
|
||||||
|
SilverBullet...
|
||||||
|
|
||||||
|
- Runs in any modern browser (including on mobile) as a PWA in two Client Modes (_online_ and _synced_ mode), where the _synced mode_ enables **100% offline operation**, keeping a copy of content in the browser, syncing back to the server when a network connection is available.
|
||||||
|
- Provides an enjoyable markdown writing experience with a clean UI, rendering text using Live Preview, further **reducing visual noise** while still providing direct access to the underlying markdown syntax.
|
||||||
|
- Supports wiki-style **page linking** using the `[[page link]]` syntax. Incoming links are indexed and appear as “Linked Mentions” at the bottom of the pages linked to thereby providing _bi-directional linking_.
|
||||||
|
- Optimized for **keyboard-based operation**:
|
||||||
|
- Quickly navigate between pages using the **page switcher** (triggered with `Cmd-k` on Mac or `Ctrl-k` on Linux and Windows).
|
||||||
|
- Run commands via their keyboard shortcuts or the **command palette** (triggered with `Cmd-/` or `Ctrl-/` on Linux and Windows).
|
||||||
|
- Use Slash Commands to perform common text editing operations.
|
||||||
|
- Provides a platform for [end-user programming](https://www.inkandswitch.com/end-user-programming/) through its support for Objects, Live Queries and Live Templates.
|
||||||
|
- Robust extension mechanism using plugs.
|
||||||
|
- **Self-hosted**: you own your data. All content is stored as plain files in a folder on disk. Back up, sync, edit, publish, script with any additional tools you like.
|
||||||
|
- SilverBullet is [open source, MIT licensed](https://github.com/silverbulletmd/silverbullet) software.
|
||||||
|
|
||||||
**Shipped version:** 0.7.5~ynh1
|
**Shipped version:** 0.7.5~ynh1
|
||||||
|
|
||||||
|
@ -24,7 +42,7 @@ This is a dummy description of this app features
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
![Screenshot of SilverBullet](./doc/screenshots/example.jpg)
|
![Screenshot of SilverBullet](./doc/screenshots/silverbullet.jpg)
|
||||||
|
|
||||||
## Documentation and resources
|
## Documentation and resources
|
||||||
|
|
||||||
|
|
22
README_fr.md
22
README_fr.md
|
@ -16,7 +16,25 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
|
||||||
|
|
||||||
## Vue d’ensemble
|
## Vue d’ensemble
|
||||||
|
|
||||||
Ceci est une fausse description des fonctionalités de l'app
|
SilverBullet se veut un atelier pour l'esprit : un espace créatif où vous collectez, créez et enrichissez vos connaissances personnelles, tout en vous permettant de faire évoluer en permanence les outils que vous utilisez pour ce faire.
|
||||||
|
|
||||||
|
Bien que vous puissiez utiliser SilverBullet comme une simple application de prise de notes qui stocke les notes dans des fichiers markdown simples sur le disque, il devient vraiment puissant entre les mains d'utilisateurs plus techniques. En exploitant les annotations de métadonnées, son infrastructure d'objets, ses Live Queries et ses Live Templates, SilverBullet devient un puissant outil de programmation pour l'utilisateur final, vous permettant de développer rapidement divers types d'applications de connaissance ad hoc.
|
||||||
|
|
||||||
|
# Fonctionnalités
|
||||||
|
|
||||||
|
SilverBullet...
|
||||||
|
|
||||||
|
- Fonctionne dans n'importe quel navigateur moderne (y compris sur mobile) en tant que PWA dans deux modes client (_online_ et _synced_ mode), où le _synced mode_ permet un fonctionnement **100% hors ligne**, conservant une copie du contenu dans le navigateur, se synchronisant à nouveau avec le serveur lorsqu'une connexion réseau est disponible.
|
||||||
|
- Fournit une expérience d'écriture markdown agréable avec une interface utilisateur propre, rendant le texte en utilisant Live Preview, **réduisant encore le bruit visuel** tout en fournissant un accès direct à la syntaxe markdown sous-jacente.
|
||||||
|
- Supporte les **liens de page** de type wiki en utilisant la syntaxe `[[page link]]`. Les liens entrants sont indexés et apparaissent en tant que "Linked Mentions" au bas des pages liées, ce qui permet de créer des liens bidirectionnels.
|
||||||
|
- Optimisé pour **l'utilisation au clavier** :
|
||||||
|
- Naviguez rapidement entre les pages à l'aide du **page switcher** (déclenché avec `Cmd-k` sur Mac ou `Ctrl-k` sur Linux et Windows).
|
||||||
|
- Exécutez des commandes via leurs raccourcis clavier ou la **palette de commandes** (déclenchée avec `Cmd-/` ou `Ctrl-/` sous Linux et Windows).
|
||||||
|
- Utiliser les commandes Slash pour effectuer des opérations courantes d'édition de texte.
|
||||||
|
- Fournit une plate-forme pour la [programmation par l'utilisateur final] (https://www.inkandswitch.com/end-user-programming/) grâce à la prise en charge des objets, des requêtes en direct et des modèles en direct.
|
||||||
|
- Mécanisme d'extension robuste utilisant des plugs.
|
||||||
|
- **Auto-hébergé** : vous êtes propriétaire de vos données. Tout le contenu est stocké sous forme de fichiers simples dans un dossier sur le disque. Sauvegardez, synchronisez, éditez, publiez, écrivez avec tous les outils supplémentaires que vous souhaitez.
|
||||||
|
- SilverBullet est [open-source, sous licence MIT](https://github.com/silverbulletmd/silverbullet)
|
||||||
|
|
||||||
**Version incluse :** 0.7.5~ynh1
|
**Version incluse :** 0.7.5~ynh1
|
||||||
|
|
||||||
|
@ -24,7 +42,7 @@ Ceci est une fausse description des fonctionalités de l'app
|
||||||
|
|
||||||
## Captures d’écran
|
## Captures d’écran
|
||||||
|
|
||||||
![Capture d’écran de SilverBullet](./doc/screenshots/example.jpg)
|
![Capture d’écran de SilverBullet](./doc/screenshots/silverbullet.jpg)
|
||||||
|
|
||||||
## Documentations et ressources
|
## Documentations et ressources
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue