Import external markdown files into your documentation site.
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mkdocs_external_import-0.0.1.tar.gz
.
File metadata
- Download URL: mkdocs_external_import-0.0.1.tar.gz
- Upload date:
- Size: 7.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.11.8 Linux/6.2.0-1019-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e0de261fc97a2f7631cad7d89f0a80c46c16774b990034918664303a7a866df |
|
MD5 | 833f3e80d033405bd9503a98267b518a |
|
BLAKE2b-256 | 02ea5f532da0ba493166e1fa4083d51b52cd509f55b454b7f328c2ea55a34c44 |
File details
Details for the file mkdocs_external_import-0.0.1-py3-none-any.whl
.
File metadata
- Download URL: mkdocs_external_import-0.0.1-py3-none-any.whl
- Upload date:
- Size: 8.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.11.8 Linux/6.2.0-1019-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f453c70dbdf0a892af6627b69c6ce578b1948a5656a1debe15d21b3fe1adeb8 |
|
MD5 | 4f0c138422eafa822b87e7769e4a43ee |
|
BLAKE2b-256 | 7ce471b68e851fdf1e94b5b9a11de6748a69c89832be84e3e0d1f098a1389202 |