https://github.com/realazthat/mdremotifier
Make READMEs self contained for publication to sites other than GH, such as npm, pypi, by turning relative images into absolute ones.
https://github.com/realazthat/mdremotifier
documentation-tool formatter links markdown npm pypi readme urls
Last synced: about 1 month ago
JSON representation
Make READMEs self contained for publication to sites other than GH, such as npm, pypi, by turning relative images into absolute ones.
- Host: GitHub
- URL: https://github.com/realazthat/mdremotifier
- Owner: realazthat
- License: mit
- Created: 2024-04-26T15:18:21.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-12T13:30:15.000Z (5 months ago)
- Last Synced: 2025-03-26T20:15:56.857Z (2 months ago)
- Topics: documentation-tool, formatter, links, markdown, npm, pypi, readme, urls
- Language: Python
- Homepage:
- Size: 514 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: .github/README.help.generated.svg
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
@font-face {
font-family: "Fira Code";
src: local("FiraCode-Regular"),
url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"),
url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff");
font-style: normal;
font-weight: 400;
}
@font-face {
font-family: "Fira Code";
src: local("FiraCode-Bold"),
url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"),
url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff");
font-style: bold;
font-weight: 700;
}
.terminal-3274778371-matrix {
font-family: Fira Code, monospace;
font-size: 20px;
line-height: 24.4px;
font-variant-east-asian: full-width;
}
.terminal-3274778371-title {
font-size: 18px;
font-weight: bold;
font-family: arial;
}
.terminal-3274778371-r1 { fill: #d9d9d9 }
.terminal-3274778371-r2 { fill: #ff8700 }
.terminal-3274778371-r3 { fill: #808080 }
.terminal-3274778371-r4 { fill: #58d1eb }
.terminal-3274778371-r5 { fill: #00af87 }
$ python -m mdremotifier.cli --help
Usage:
python -m mdremotifier.cli
[
-h
]
-i
INPUT
-o
OUTPUT
--url-prefix
URL_PREFIX
[
--img-url-prefix
IMG_URL_PREFIX
] [
--all-references
] [
--version
]
README.md: Change local {links,images} to remote.
Optional Arguments:
-h
,
--help
show this help message and exit
-i
,
--input
INPUT
Input markdown file, use "-" for stdin.
-o
,
--output
OUTPUT
Output markdown file, use "-" for stdout.
--url-prefix
URL_PREFIX
URL prefix to replace the local URLs with. Should probably end in a slash. Example:
"https://github.com/realazthat/mdremotifier/blob/master/".
--img-url-prefix
IMG_URL_PREFIX
URL prefix to replace the local URLs with, specifically for images. Should probably end in a slash. Example:
"https://raw.githubusercontent.com/realazthat/mdremotifier/master/". Defaults to the value of
--url-prefix
.
--all-references
Should all references be updated be externalized, or only those that are actually used by links and images?
--version
Show the version and exit.