vimwiki
v2024.01.24
中文
Vimwiki adalah wiki pribadi untuk VIM - sejumlah file teks tertaut yang memiliki penyorotan sintaks sendiri. Lihat Wiki Vimwiki untuk contoh situs web yang dibangun dengan Vimwiki!
Jika Anda tertarik untuk berkontribusi, lihat bagian ini.
Dengan Vimwiki, Anda bisa:
Untuk melakukan awal yang cepat, tekan <Leader>ww (default adalah ww ) untuk pergi ke file wiki indeks Anda. Secara default, terletak di ~/vimwiki/index.wiki . Lihat :h vimwiki_list untuk mendaftarkan jalur/wiki yang berbeda.
Beri makan dengan contoh berikut:
= My knowledge base =
* Tasks -- things to be done _yesterday_!!!
* Project Gutenberg -- good books are power.
* Scratchpad -- various temporary stuff.
Tempatkan kursor Anda pada Tasks dan tekan Enter untuk membuat tautan. Setelah ditekan, Tasks akan menjadi [[Tasks]] - tautan vimwiki. Tekan Enter lagi untuk membukanya. Edit file, simpan, lalu tekan Backspace untuk melompat kembali ke indeks Anda.
Tautan Vimwiki dapat dibangun dari lebih dari satu kata. Cukup pilih kata -kata yang akan ditautkan dan tekan Enter. Cobalah, dengan Project Gutenberg . Hasilnya seharusnya terlihat seperti:
= My knowledge base =
* [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff.
Vimwiki telah diuji pada vim> = 7.3 . Ini dapat bekerja pada versi yang lebih lama tetapi tidak akan didukung secara resmi. Ia diketahui bekerja di Neovim, meskipun cenderung memiliki bug spesifik neovim.
Pastikan Anda memiliki pengaturan ini di file VIMRC Anda:
set nocompatible
filetype plugin on
syntax onTanpa mereka, Vimwiki tidak akan bekerja dengan baik.
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
Catatan:
:h helptags untuk masalah dengan menginstal dokumentasi.:h packages cd ~ /.vim
mkdir bundle
cd bundle
git clone https://github.com/vimwiki/vimwiki.git
Tambahkan berikut ini ke konfigurasi plugin di VIMRC Anda:
Plug ' vimwiki/vimwiki '
Kemudian jalankan :PlugInstall .
Tambahkan Plugin 'vimwiki/vimwiki' ke file vimrc Anda dan jalankan:
vim +PluginInstall +qall
Unduh arsip zip dan ekstrak di ~/.vim/bundle/
Kemudian luncurkan VIM, jalankan :Helptags dan kemudian :help vimwiki untuk memverifikasi itu telah diinstal.
= 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
Untuk elemen sintaks lainnya, lihat :h vimwiki-syntax
- [.] Partially completed item with sub-tasks
- [X] Completed sub-task
- [ ] Incomplete sub-task
- [ ] Other incomplete sub-task
- [ ] Incomplete item
Catatan: Terminal Anda dapat mencegah menangkap beberapa binding default yang tercantum di bawah ini. Lihat :h vimwiki-local-mappings untuk saran untuk binding alternatif jika Anda mengalami masalah.
<Leader>ww - Buka file indeks wiki default.<Leader>wt - Buka file indeks wiki default di tab baru.<Leader>ws - pilih dan buka file indeks wiki.<Leader>wd - Hapus file wiki yang Anda hadapi.<Leader>wr - Ganti nama file wiki yang Anda hadapi.<Enter> - ikuti/buat tautan wiki.<Shift-Enter> -split dan ikuti/buat tautan wiki.<Ctrl-Enter> -Vertikal split dan ikuti/buat tautan wiki.<Backspace> - Kembali ke tautan wiki induk (sebelumnya).<Tab> - Temukan tautan wiki berikutnya.<Shift-Tab> -Temukan tautan wiki sebelumnya. Lihat dokumentasi lengkap di :h vimwiki-mappings untuk melihat lebih banyak binding.
:Vimwiki2HTML - Konversi tautan wiki saat ini ke html.:VimwikiAll2HTML - konversi semua tautan wiki Anda ke html.:help vimwiki-commands -Daftar semua perintah.:help vimwiki - Dokumen Bantuan Vimwiki Jenderal. Vimwiki saat ini dikirimkan dengan 3 sintaksis: Vimwiki (default), Markdown (Markdown), dan Mediawiki (Media). Dari jumlah tersebut, sintaks Vimwiki asli paling didukung, diikuti oleh Markdown. Tidak ada janji yang dibuat untuk Mediawiki.
Catatan: Hanya Sintaks Default yang dikirimkan dengan konverter HTML bawaan. Untuk Markdown atau MediaWiki lihat :h vimwiki-option-custom_wiki2html . Beberapa contoh dan alat pihak ke -3 tersedia di sini.
Jika Anda lebih suka menggunakan sintaksis Markdown atau MediaWiki, atur opsi berikut di .vimrc Anda:
let g: vimwiki_list = [{ ' path ' : ' ~/vimwiki/ ' ,
' syntax ' : ' markdown ' , ' ext ' : ' md ' }]
Opsi ini akan memperlakukan semua file Markdown dalam sistem Anda sebagai bagian dari Vimwiki (periksa set filetype? ). Menambahkan
let g: vimwiki_global_ext = 0 ke .vimrc Anda untuk membatasi operasi Vimwiki hanya untuk jalur yang tercantum dalam g:vimwiki_list . File penurunan harga lainnya tidak akan diperlakukan sebagai halaman wiki. Lihat G: vimwiki_global_ext.
Jika Anda ingin mematikan dukungan untuk ekstensi lain (misalnya, menonaktifkan secara tidak sengaja membuat wiki baru dan tautan untuk file penurunan harga normal), atur opsi berikut di .vimrc Anda sebelum paket vimwiki:
let g: vimwiki_ext2syntax = {}Lihat G: vimiki_ext2syntax
Masalah GitHub adalah metode utama untuk meningkatkan laporan bug atau permintaan fitur.
Sumber Daya Tambahan:
Vimwiki memiliki banyak pengguna tetapi hanya sedikit pengembang yang berulang atau orang yang membantu masyarakat. Karena itu, bantuan Anda dihargai. Semua orang bisa membantu! Lihat #625 untuk informasi tentang bagaimana Anda dapat membantu.
Juga, lihat Kontribusi.MD dan Design_notes.md
Lisensi MIT
Hak Cipta (C) 2008-2010 Maxim Kim 2013-2017 Daniel Schemala
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Pemberitahuan hak cipta di atas dan pemberitahuan izin ini harus dimasukkan dalam semua salinan atau bagian substansial dari perangkat lunak.
Perangkat lunak ini disediakan "sebagaimana adanya", tanpa jaminan apa pun, tersurat maupun tersirat, termasuk tetapi tidak terbatas pada jaminan dapat diperjualbelikan, kebugaran untuk tujuan tertentu dan nonpringement. Dalam hal apa pun penulis atau pemegang hak cipta tidak akan bertanggung jawab atas klaim, kerusakan atau tanggung jawab lainnya, baik dalam tindakan kontrak, gugatan atau sebaliknya, timbul dari, di luar atau sehubungan dengan perangkat lunak atau penggunaan atau transaksi lain dalam perangkat lunak.
