Import GitHub Readme

approved

by Chasebank87

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

★ 10 stars↓ 885 downloadsUpdated 1y agoMIT
View on GitHub

GitHub README Importer Plugin

Overview

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.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.