Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 1.31 KB

README.md

File metadata and controls

48 lines (29 loc) · 1.31 KB
Raw

Overview

This repository contains two Python scripts designed to enhance the functionality of VimWiki, a personal wiki for Vim.

Scripts

  1. ZimWiki to VimWiki Importer (zimvim_importer.py): This script imports Zim wiki notes into VimWiki, modifying the file format to be compatible with VimWiki.

  2. VimWiki Indexer (vimwiki-indexer.py): This script indexes VimWiki pages and adds a navigation structure to the top of each page, facilitating easier navigation and organization within the wiki.

Installation

Prerequisites

  • Python 3.x
  • Access to a terminal or command-line interface

Steps

  1. Clone or download this repository to your local machine.
  2. Ensure Python 3.x is installed on your system.

Usage

ZimWiki to VimWiki Importer

  1. Run zimvim_importer.py in your terminal.
  2. Enter the path to your VimWiki directory when prompted.
  3. The script will automatically process and import your Zim wiki notes into VimWiki.

VimWiki Indexer

  1. Run vimwiki-indexer.py in your terminal.
  2. Enter the path to your VimWiki directory when prompted.
  3. The script will index your VimWiki pages and add a navigation structure to the top of each page.

Contributing

Contributions, issues, and feature requests are welcome.

License

MIT License

Contact

miha@autumn8.io