vimwiki
v2024.01.24
中文
Vimwiki est un wiki personnel pour VIM - un certain nombre de fichiers texte liés qui ont leur propre syntaxe en surbrillance. Voir le Vimwiki Wiki pour un exemple de site Web construit avec Vimwiki!
Si vous êtes intéressé à contribuer, consultez cette section.
Avec Vimwiki, vous pouvez:
Pour faire un démarrage rapide, appuyez sur <Leader>ww (par défaut est ww ) pour accéder à votre fichier Wiki index. Par défaut, il est situé dans ~/vimwiki/index.wiki . Voir :h vimwiki_list pour enregistrer un chemin / wiki différent.
Nourrissez-le avec l'exemple suivant:
= My knowledge base =
* Tasks -- things to be done _yesterday_!!!
* Project Gutenberg -- good books are power.
* Scratchpad -- various temporary stuff.
Placez votre curseur sur Tasks et appuyez sur Entrée pour créer un lien. Une fois pressées, Tasks deviendront [[Tasks]] - un lien vimwiki. Appuyez à nouveau sur Entrée pour l'ouvrir. Modifiez le fichier, enregistrez-le, puis appuyez sur Backpace pour revenir à votre index.
Un lien vimwiki peut être construit à partir de plus d'un mot. Sélectionnez simplement visuellement les mots à lier et appuyez sur Entrée. Essayez-le, avec Project Gutenberg . Le résultat devrait ressembler à quelque chose:
= My knowledge base =
* [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff.
Vimwiki a été testé sur VIM> = 7.3 . Il peut fonctionner sur des versions plus anciennes mais ne sera pas officiellement soutenu. Il est connu pour fonctionner sur Neovim, bien qu'il soit susceptible d'avoir des bogues spécifiques à Neovim.
Assurez-vous d'avoir ces paramètres dans votre fichier VIMRC:
set nocompatible
filetype plugin on
syntax onSans eux, Vimwiki ne fonctionnera pas correctement.
git clone https://github.com/vimwiki/vimwiki.git ~ /.vim/pack/plugins/start/vimwiki
# to generate documentation i.e. ':h vimwiki'
vim -c ' helptags ~/.vim/pack/plugins/start/vimwiki/doc ' -c quit
Notes:
:h helptags pour les problèmes avec l'installation de la documentation.:h packages . cd ~ /.vim
mkdir bundle
cd bundle
git clone https://github.com/vimwiki/vimwiki.git
Ajoutez ce qui suit à la configuration du plugin dans votre VIMRC:
Plug ' vimwiki/vimwiki '
Ensuite, exécutez :PlugInstall .
Ajoutez Plugin 'vimwiki/vimwiki' à votre fichier vimrc et exécutez:
vim +PluginInstall +qall
Téléchargez l'archive zip et extraire dans ~/.vim/bundle/
Ensuite, lancez VIM, exécutez :Helptags puis :help vimwiki à vérifier qu'il a été installé.
= Header1 =
== Header2 ==
=== Header3 ===
*bold* -- bold text
_italic_ -- italic text
[[wiki link]] -- wiki link
[[wiki link|description]] -- wiki link with description
* bullet list item 1
- bullet list item 2
- bullet list item 3
* bullet list item 4
* bullet list item 5
* bullet list item 6
* bullet list item 7
- bullet list item 8
- bullet list item 9
1. numbered list item 1
2. numbered list item 2
a) numbered list item 3
b) numbered list item 4
Pour d'autres éléments de syntaxe, voir :h vimwiki-syntax
- [.] Partially completed item with sub-tasks
- [X] Completed sub-task
- [ ] Incomplete sub-task
- [ ] Other incomplete sub-task
- [ ] Incomplete item
Remarque: Votre terminal peut empêcher la capture de certaines des liaisons par défaut énumérées ci-dessous. Voir :h vimwiki-local-mappings pour les suggestions de liaisons alternatives si vous rencontrez un problème.
<Leader>ww - Ouvrez le fichier d'index Wiki par défaut.<Leader>wt - Ouvrez le fichier d'index Wiki par défaut dans un nouvel onglet.<Leader>ws - Sélectionnez et ouvrez le fichier d'index Wiki.<Leader>wd - Supprimer le fichier wiki dans lequel vous vous trouvez.<Leader>wr - Renommer le fichier wiki dans lequel vous vous trouvez.<Enter> - Suivez / créez un lien wiki.<Shift-Enter> - Split et suivez / créez un lien wiki.<Ctrl-Enter> - Vertical Split et suivez / créez un lien wiki.<Backspace> - Retournez au lien Wiki Parent (précédent).<Tab> - Trouvez le lien Wiki suivant.<Shift-Tab> - Trouvez le lien wiki précédent. Reportez-vous à la documentation complète à :h vimwiki-mappings pour voir beaucoup plus de liaisons.
:Vimwiki2HTML - Convertir le lien wiki actuel vers HTML.:VimwikiAll2HTML - Convertissez tous vos liens wiki en HTML.:help vimwiki-commands - Listez toutes les commandes.:help vimwiki - Général Vimwiki Aidez les documents. Vimwiki est actuellement expédié avec 3 syntaxes: vimwiki (par défaut), Markdown (Markdown) et MediaWiki (Media). Parmi ceux-ci, la syntaxe native de Vimwiki est mieux prise en charge, suivie de Markdown. Aucune promesse n'est faite pour MediaWiki.
Remarque: Seule la syntaxe par défaut est livrée avec un convertisseur HTML intégré. Pour Markdown ou MediaWiki, voir :h vimwiki-option-custom_wiki2html . Quelques exemples et outils tiers sont disponibles ici.
Si vous préférez utiliser des syntaxes Markdown ou MediaWiki, définissez l'option suivante dans votre .vimrc :
let g: vimwiki_list = [{ ' path ' : ' ~/vimwiki/ ' ,
' syntax ' : ' markdown ' , ' ext ' : ' md ' }]
Cette option traitera tous les fichiers Markdown dans votre système dans le cadre de Vimwiki (vérifiez set filetype? ). Ajouter
let g: vimwiki_global_ext = 0 à votre .vimrc pour restreindre l'opération de Vimwiki sur uniquement les chemins répertoriés en g:vimwiki_list . D'autres fichiers Markdown ne seraient pas traités comme des pages wiki. Voir g: vimwiki_global_ext.
Si vous souhaitez désactiver la prise en charge d'une autre extension (par exemple, la désactivation de la création accidentelle de nouveaux wiki et liens pour les fichiers de marque normale), définissez l'option suivante dans votre .vimrc avant PackAdd Vimwiki:
let g: vimwiki_ext2syntax = {}Voir g: vimiki_ext2Syntax
Les problèmes GitHub sont la principale méthode pour augmenter les rapports de bogues ou les demandes de fonctionnalités.
Ressources supplémentaires:
Vimwiki a beaucoup d'utilisateurs mais seulement très peu de développeurs récurrents ou de personnes aidant la communauté. Votre aide est donc appréciée. Tout le monde peut aider! Voir # 625 pour plus d'informations sur la façon dont vous pouvez vous aider.
Jetez également un œil à contribution.md et design_notes.md
Licence MIT
Copyright (c) 2008-2010 Maxim Kim 2013-2017 Daniel Schemala
L'autorisation est accordée gratuitement à toute personne qui obtient une copie de ce logiciel et des fichiers de documentation associés (le "logiciel"), pour traiter le logiciel sans restriction, y compris sans limiter les droits d'utilisation, de copie, de modification, de fusion, de publication, de distribution, de sublince et / ou de vendre des copies des conditions suivantes.
L'avis de droit d'auteur ci-dessus et le présent avis d'autorisation sont inclus dans toutes les copies ou des parties substantielles du logiciel.
Le logiciel est fourni "tel quel", sans garantie d'aucune sorte, express ou implicite, y compris, mais sans s'y limiter, les garanties de qualité marchande, d'adéquation à un usage particulier et de non-contrefaçon. En aucun cas, les auteurs ou les détenteurs de droits d'auteur ne seront pas responsables de toute réclamation, dommage ou autre responsabilité, que ce soit dans une action de contrat, de délit ou autre, découlant de, hors du logiciel ou de l'utilisation ou d'autres relations dans le logiciel.
