vimwiki
v2024.01.24
中文
Vimwiki ist ein persönliches Wiki für VIM - eine Reihe von verknüpften Textdateien mit einer eigenen Syntax -Hervorhebung. Sehen Sie sich das Vimwiki Wiki für eine Beispiel -Website, die mit Vimwiki erstellt wurde!
Wenn Sie daran interessiert sind, einen Beitrag zu leisten, sehen Sie diesen Abschnitt.
Mit Vimwiki können Sie:
Um einen kurzen Start zu erzielen, drücken Sie <Leader>ww (Standard ist ww ), um zu Ihrer Index -Wiki -Datei zu gehen. Standardmäßig befindet es sich in ~/vimwiki/index.wiki . Siehe :h vimwiki_list zur Registrierung eines anderen Pfades/Wiki.
Füttern Sie es mit dem folgenden Beispiel:
= My knowledge base =
* Tasks -- things to be done _yesterday_!!!
* Project Gutenberg -- good books are power.
* Scratchpad -- various temporary stuff.
Platzieren Sie Ihren Cursor auf Tasks und drücken Sie die Eingabetaste, um einen Link zu erstellen. Sobald Sie gedrückt werden, werden Tasks [[Tasks]] - ein Vimwiki -Link. Drücken Sie die Eingabetaste erneut, um es zu öffnen. Bearbeiten Sie die Datei, speichern Sie sie und drücken Sie dann den Rückraum, um zurück zu Ihrem Index zu springen.
Ein Vimwiki -Link kann aus mehr als einem Wort konstruiert werden. Wählen Sie einfach visuell die zu verknüpften Wörter aus und drücken Sie die Eingabetaste. Versuchen Sie es mit Project Gutenberg . Das Ergebnis sollte ungefähr aussehen wie:
= My knowledge base =
* [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff.
Vimwiki wurde auf VIM> = 7,3 getestet. Es kann bei älteren Versionen funktionieren, wird aber nicht offiziell unterstützt. Es ist bekannt, an Neovim zu arbeiten, obwohl es wahrscheinlich Neovim-spezifische Fehler hat.
Stellen Sie sicher, dass Sie diese Einstellungen in Ihrer VIMRC -Datei haben:
set nocompatible
filetype plugin on
syntax onOhne sie funktioniert Vimwiki nicht richtig.
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
Anmerkungen:
:h helptags für Probleme mit der Installation der Dokumentation.:h packages . cd ~ /.vim
mkdir bundle
cd bundle
git clone https://github.com/vimwiki/vimwiki.git
Fügen Sie Folgendes der Plugin-Konfiguration in Ihrem VIMRC hinzu:
Plug ' vimwiki/vimwiki '
Dann laufen Sie :PlugInstall .
Fügen Sie Ihrer VIMRC -Datei Plugin 'vimwiki/vimwiki' hinzu und führen Sie aus:
vim +PluginInstall +qall
Laden Sie das ZIP -Archiv herunter und extrahieren Sie es in ~/.vim/bundle/
Dann starten Sie Vim, Run :Helptags und dann :help vimwiki , zu überprüfen, ob es installiert wurde.
= 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
Für andere Syntaxelemente siehe :h vimwiki-syntax
- [.] Partially completed item with sub-tasks
- [X] Completed sub-task
- [ ] Incomplete sub-task
- [ ] Other incomplete sub-task
- [ ] Incomplete item
Hinweis: Ihr Terminal kann verhindern, dass einige der unten aufgeführten Standardbindungen erfasst werden. Siehe :h vimwiki-local-mappings für Vorschläge für alternative Bindungen, wenn Sie auf ein Problem stoßen.
<Leader>ww - Die Standard -Wiki -Indexdatei öffnen.<Leader>wt - Öffnen Sie die Standard -Wiki -Indexdatei in einer neuen Registerkarte.<Leader>ws - Wiki Index -Datei auswählen und öffnen.<Leader>wd - Wiki -Datei löschen, in der Sie sich befinden.<Leader>wr - Benennen Sie die Wiki -Datei um, in der Sie sich befinden.<Enter> - Wiki Link folgen/erstellen.<Shift-Enter> -Wiki Link teilen und folgen/erstellen.<Ctrl-Enter> -Vertikaler Split und folgen/erstellen Wiki-Link.<Backspace> - Kehren Sie zu einem übergeordneten (vorherigen) Wiki -Link zurück.<Tab> - Suchen Sie den nächsten Wiki -Link.<Shift-Tab> -Finden Sie den vorherigen Wiki-Link. Siehe die vollständige Dokumentation unter :h vimwiki-mappings um viele weitere Bindungen zu sehen.
:Vimwiki2HTML - Konvertieren Sie den aktuellen Wiki -Link in HTML.:VimwikiAll2HTML - Konvertieren Sie alle Ihre Wiki -Links in HTML.:help vimwiki-commands -Listen Sie alle Befehle auf.:help vimwiki - General Vimwiki Help Docs. Vimwiki wird derzeit mit 3 Syntaxen geliefert: Vimwiki (Standard), Markdown (Markdown) und Mediawiki (Medien). Von diesen wird die native Vimwiki -Syntax am besten unterstützt, gefolgt von Markdown. Für Medienwiki werden keine Versprechen gemacht.
Hinweis: Nur die Standard-Syntaxschiff mit einem integrierten HTML-Konverter. Für Markdown oder Mediawiki siehe :h vimwiki-option-custom_wiki2html . Einige Beispiele und Tools von Drittanbietern finden Sie hier.
Wenn Sie es vorziehen möchten, entweder Markdown- oder MediaWiki -Syntaxes zu verwenden, legen Sie die folgende Option in Ihrem .vimrc fest:
let g: vimwiki_list = [{ ' path ' : ' ~/vimwiki/ ' ,
' syntax ' : ' markdown ' , ' ext ' : ' md ' }]
Mit dieser Option werden alle Markdown -Dateien in Ihrem System als Teil von Vimwiki behandelt ( set filetype? ). Hinzufügen
let g: vimwiki_global_ext = 0 auf Ihr .vimrc um die Operation von Vimwiki auf nur die in g:vimwiki_list aufgeführten Pfade zu beschränken. Andere Markdown -Dateien würden nicht als Wiki -Seiten behandelt. Siehe G: vimwiki_global_ext.
Wenn Sie die Unterstützung für eine andere Erweiterung deaktivieren möchten (z. B. das Deaktivieren von neuem Wiki und Link für normale Markdown -Dateien deaktiviert), stellen Sie die folgende Option in Ihrem .vimrc vor Packadd Vimwiki fest:
let g: vimwiki_ext2syntax = {}Siehe G: vimiki_ext2Syntax
GitHub -Probleme sind die primäre Methode zur Erhöhung von Fehlerberichten oder Feature -Anfragen.
Zusätzliche Ressourcen:
Vimwiki hat viele Benutzer, aber nur sehr wenige wiederkehrende Entwickler oder Menschen, die der Community helfen. Ihre Hilfe wird daher geschätzt. Jeder kann helfen! Informationen darüber finden Sie, wie Sie helfen können.
Werfen Sie auch einen Blick auf den Beitrag.md und design_notes.md
MIT -Lizenz
Copyright (C) 2008-2010 Maxim Kim 2013-2017 Daniel Schemala
Die Erlaubnis wird hiermit einer Person, die eine Kopie dieser Software und zugehörigen Dokumentationsdateien (der "Software") erhält, kostenlos erteilt, um die Software ohne Einschränkung zu behandeln, einschließlich ohne Einschränkung der Rechte, zu verwenden, zu kopieren, zu modifizieren, zusammenzufassen, zu veröffentlichen, zu veröffentlichen, zu verteilen, zu verteilt, und/oder Kopien der Software zu ermöglichen, um Personen zu beanstanden, an denen die Software zugänglich ist, um die folgenden Bedingungen zu beantragen.
Die oben genannte Copyright -Mitteilung und diese Erlaubnisbekanntmachung müssen in alle Kopien oder wesentlichen Teile der Software enthalten sein.
Die Software wird "wie es ist" ohne Garantie jeglicher Art, ausdrücklich oder stillschweigend bereitgestellt, einschließlich, aber nicht beschränkt auf die Gewährleistung der Handelsfähigkeit, die Eignung für einen bestimmten Zweck und die Nichtverletzung. In keinem Fall sind die Autoren oder Urheberrechtsinhaber für Ansprüche, Schäden oder andere Haftungen haftbar, sei es in einer Vertragsklage, unerbittlich oder auf andere Weise, die sich aus oder im Zusammenhang mit der Software oder anderen Geschäften in der Software ergeben.
