Skip to main content

MKDocs External Import

Import external markdown files into your documentation site.

Usage

Install mkdocs-external-import:

  • pip install mkdocs-external-import
  • poetry add mkdocs-external-import

Add to mkdocs.yml:

plugins:
  - external-import

Reference an external Markdown file in a codeblock:

```import-external-content
https://raw.githubusercontent.com/acodeninja/mkdocs-external-import/main/README.md
```

Build your docs, or run a local development server:

  • mkdocs build
  • mkdocs serve

The logs will show the following output:

INFO    -  mkdocs_external_import: Importing external content from: https://raw.githubusercontent.com/acodeninja/mkdocs-external-import/main/README.md

Metadata

Release files for mkdocs-external-import 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-external-import 0.0.1
File Size Uploaded
mkdocs_external_import-0.0.1.tar.gz 7.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-external-import 0.0.1
File Interpreter ABI Platform
mkdocs_external_import-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 15.0 kB

Release files / mkdocs_external_import-0.0.1.tar.gz

Download URL mkdocs_external_import-0.0.1.tar.gz
Size 7.0 kB
Tags Source
SHA-256 checksum
How to use checksums
3e0de261fc97a2f7631cad7d89f0a80c46c16774b990034918664303a7a866df
BLAKE2b-256 checksum
How to use checksums
02ea5f532da0ba493166e1fa4083d51b52cd509f55b454b7f328c2ea55a34c44
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.1 CPython/3.11.8 Linux/6.2.0-1019-azure

Release files / mkdocs_external_import-0.0.1-py3-none-any.whl

Download URL mkdocs_external_import-0.0.1-py3-none-any.whl
Size 8.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9f453c70dbdf0a892af6627b69c6ce578b1948a5656a1debe15d21b3fe1adeb8
BLAKE2b-256 checksum
How to use checksums
7ce471b68e851fdf1e94b5b9a11de6748a69c89832be84e3e0d1f098a1389202
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.1 CPython/3.11.8 Linux/6.2.0-1019-azure

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page