Search...Search plugins and themes...
⌘K
Sign in
  • Get started
  • Download
  • Pricing
  • Enterprise
  • Account
  • Obsidian
  • Overview
  • Sync
  • Publish
  • Canvas
  • Mobile
  • Web Clipper
  • CLI
  • Learn
  • Help
  • Developers
  • Changelog
  • About
  • Roadmap
  • Blog
  • Resources
  • System status
  • License overview
  • Terms of service
  • Privacy policy
  • Security
  • Community
  • Plugins
  • Join the community
  • Discord
  • Forum / 中文论坛
  • Merch store
  • Brand guidelines
Follow us
DiscordTwitterBlueskyThreadsMastodonYouTubeGitHub
© 2026 Obsidian
GitHub

Import GitHub Readme

chasebank87chasebank87984 downloads

Allows you to import a GitHub README file into your vault.

Add to Obsidian
  • Overview
  • Scorecard
  • Updates1

The GitHubReadmeImporter is a plugin for Obsidian that allows users to import the README file from a GitHub repository directly into their notes. This plugin fetches the README content, converts it from HTML to Markdown, and handles various formatting issues to ensure the content is clean and readable.

Features

  • Fetch README: Retrieve the README file from a specified GitHub repository.
  • Convert HTML to Markdown: Convert HTML content within the README to Markdown format.
  • Clean Up Content: Remove unnecessary HTML tags and empty lines.
  • Resolve Image URLs: Convert relative image URLs to absolute URLs to ensure images are displayed correctly.

Installation

  1. Download the plugin files and place them in your Obsidian plugins directory.
  2. Enable the plugin from the Obsidian settings.

Usage

  1. Open a Markdown file in Obsidian.
  2. Use the command palette (Ctrl+P or Cmd+P) and search for "Import GitHub README".
  3. Enter the URL of the GitHub repository when prompted.
  4. The README content will be fetched, processed, and inserted into your current note.

License

This project is licensed under the MIT License. See the LICENSE file for details.

74%
HealthGood
ReviewCaution
About
Fetch a GitHub repository README and insert it into the current note. Convert embedded HTML to Markdown, remove unnecessary tags and empty lines, and convert relative image URLs to absolute links for correct rendering.
ImportIntegrationsMarkdown
Details
Current version
1.0.0
Last updated
2 years ago
Created
2 years ago
Updates
1 release
Downloads
984
Compatible with
Obsidian 0.15.0+
License
MIT
Report bugRequest featureReport plugin
Sponsor
Buy Me a Coffee
Author
chasebank87chasebank87
chaseelder.com
GitHubchasebank87
  1. Community
  2. Plugins
  3. Import
  4. Import GitHub Readme

Related plugins

Importer

Import data from Notion, Evernote, Apple Notes, Microsoft OneNote, Google Keep, Bear, Roam, and HTML files.

Zotero Integration

Insert and import citations, bibliographies, notes, and PDF annotations from Zotero.

Readwise Official

Sync highlights from Readwise to your vault.

Custom Frames

Turn web apps into panes using iframes with custom styling. Also comes with presets for Google Keep, Todoist and more.

ZotLit

Integrate with Zotero, create literature notes, and insert citations from a Zotero library.

Telegram Sync

Transfer messages and files from Telegram to Obsidian.

BRAT

Easily install a beta version of a plugin for testing.

Outliner

Work with your lists like in Workflowy or Roam Research.

Various Complements

Complete words similar to auto-completion in an IDE.

Maps

Adds a map layout to bases so you can display notes as an interactive map view.