Skip to content

dentolos19/git-wiki-editor

Repository files navigation

Icon Git Wiki Editor

Visual Studio Marketplace Version Visual Studio Marketplace Downloads

An easy way to quickly edit wikis locally inside your editor!

What is my rationale of making this extension? I want to edit my projects' wiki quickly and easily right inside my editor just by running commands instead of typing commands manually inside the terminal. There wasn't any specialized extensions for editing GitHub wikis and extensions like Remote Repositories doesn't allow you to remotely access them as well. So, why not make my own extension? I thought it would be fun learning something new. 😎

⚒️ Usage

To get started, go check out the wiki to learn how to use this extension.

⚙️ Features

  • Supports GitHub
  • Able to clone wiki in isolation
  • Able to customize your commit

Roadmap

  • Support GitLab, CodeBerg and Azure DevOps (need help)
  • Designate special repositories (e.g., dentolos19/dentolos19) as a hub for the user's knowledgebase

🧑‍💻 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Prerequisites

Installation

  1. Clone this repository: git clone https://github.com/dentolos19/git-wiki-editor.git
  2. Install dependencies: pnpm install
  3. Open the project: code .
  4. Run the extension: F5

💖 Credits

📜 License

Distributed under the MIT License. See LICENSE for more information.