https://github.com/iwe-org/iwe
LSP for Markdown notes taking
https://github.com/iwe-org/iwe
gtd helix lsp markdown neovim notes para pkm vscode zed zettelkasten
Last synced: about 2 months ago
JSON representation
LSP for Markdown notes taking
- Host: GitHub
- URL: https://github.com/iwe-org/iwe
- Owner: iwe-org
- License: apache-2.0
- Created: 2024-09-20T01:38:23.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-08-12T10:59:09.000Z (about 2 months ago)
- Last Synced: 2025-08-12T12:41:22.117Z (about 2 months ago)
- Topics: gtd, helix, lsp, markdown, neovim, notes, para, pkm, vscode, zed, zettelkasten
- Language: Rust
- Homepage: https://iwe.md
- Size: 1.27 MB
- Stars: 332
- Watchers: 4
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# About IWE
[IWE](https://iwe.md) is an open-source, local-first, markdown-based note-taking tool. It serves as a personal knowledge management (PKM) solution **designed for developers**.
IWE integrates seamlessly with popular developer text editors such as VSCode, Neovim, Zed, Helix, and others. It connects with your editor through the Language Server Protocol (LSP) to assist you in writing and maintaining your Markdown documents.
IWE offers powerful features such as **search**, **auto-complete**, **go to definition**, **find references**, **rename refactoring**, and more. In addition to standard Markdown, it also supports wiki-style links, tables, and other Markdown extensions.
IWE includes **AI** capabilities that can be accessed right from your text editor. You can effortlessly **rewrite** text, **expand** on ideas, **highlight** important words, or even add some **emojis**. Want to customize your AI experience? You can easily add your own AI commands by updating the config file with your custom prompts.
Looking to spark creativity in your writing? You can designate certain notes as "prompts" to inspire and develop fresh content. Simply apply these prompts to your other notes (using LSP completions menu) to help generate new ideas and insights.
The primary focus of IWE is to be your ultimate writing assistant and keep your notes tidy and structured. It understands the structure of your documents defined by **headers**, **lists**, and **links** and supports advanced refactorings, such as **extract/embed** note and many other via LSP **code actions**.
While IWE supports sub-directories and relative links, it also allows you to organize notes **hierarchically** using Map of Content ([MOC](https://github.com/iwe-org/iwe/wiki/Map-of-content)) documents.
> [!NOTE]
>
> The goal of the project is to make managing knowledge as seamless as managing code, enabling your PMK system to function like an IDE for Writing (IWE).
The main LSP features are:
- 🤖 **Generate** or **Modify** text using AI commands
- 🔍 **Search** through your notes
- 🧭 **Navigate** through markdown links
- ✨ **Auto-complete** links as you type
- 📥 **Extract** or **inline** sub-notes seamlessly
- 📝 **Format** the document and update link titles automatically
- 🔄 **Rename** files and automatically update all the links
- 🔗 Search for **backlinks** to find references to the current document
- 💡 Display **inlay hints** with parent note references and link counts
- 🔹 Change outline type from headers to list and vice-versa
You can learn more on the [LSP Features](https://github.com/iwe-org/iwe/wiki/LSP-features) page.
IWE also provides a CLI utility that allows you to process thousands of documents in just a second. With IWE, you can reformat documents and update link titles across your entire library. Additionally, you can use the CLI mode to combine multiple files into one comprehensive document. More information is available [here](https://github.com/iwe-org/iwe/wiki/CLI-features).
Quick Demos:
Notes search
Auto-formatting
Extract note
## How to install
You can find the installation instructions in the [Quick Start Guide](https://iwe.md/quick-start).
Check [usage guide](https://github.com/iwe-org/iwe/wiki/Usage) for more information.
## Get Involved
IWE fully depends on community support, which is essential for its growth and development. We encourage you to participate in [discussions](https://github.com/iwe-org/iwe/discussions) and report any [issues](https://github.com/iwe-org/iwe/issues) you encounter.
Contributions to the project [documentation](https://github.com/iwe-org/iwe/wiki) are also highly appreciated.
### Plugins / Packages
This repository is for Rust code and crates publishing only. Plugins and packages are in separate repositories. If you are willing to help with a non-listed package type, I'm happy to add a repo for it.
- VSCode plugin is avialbe [here](https://marketplace.visualstudio.com/items?itemName=IWE.iwe) ([repository](https://github.com/iwe-org/vscode-iwe))
- Zed plugin [repository](https://github.com/iwe-org/zed-iwe)
We're looking for a maintainer for the dedicated Neovim [plugin](https://github.com/iwe-org/iwe.nvim).
### Debug Mode
IWE includes a debug mode, which can be enabled by setting the `IWE_DEBUG` environment variable. In debug mode, IWE LSP will generate a detailed log file named `iwe.log` in the directory where you started it. Including logs with your [issue](https://github.com/iwe-org/iwe/issues) report will help us to resolve it faster.
```
export IWE_DEBUG=true; nvim
```
### Special thanks to
- A heartfelt thank you to [Sergej Podatelew](https://github.com/spodatelev) for his outstanding work on the VSCode plugin.
- Deep appreciation to [Daniel Fichtinger](https://github.com/ficcdaf) for his contributions to the project documentation and community.
### Inspired by many other open-source projects
- [pandoc](https://pandoc.org)
- [zk notes](https://github.com/zk-org/zk)
- [neuron](https://github.com/srid/neuron)
- [rust-analyzer](https://rust-analyzer.github.io)