| Name | mdhub JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | Convert Markdown files to styled HTML with a GitHub-like appearance. Easily switch between light and dark modes. |
| upload_time | 2023-11-05 21:00:56 |
| maintainer | |
| docs_url | None |
| author | GlizzyKingDreko |
| requires_python | |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MDHub
 
Easily convert Markdown files to styled HTML. Perfect for delivering projects to clients who might not be familiar with `.md` files.
## Table of Contents
- [MDHub](#mdhub)
- [Table of Contents](#table-of-contents)
- [Why MDHUB?](#why-mdhub)
- [The name](#the-name)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [My links](#my-links)
## Why MDHUB?
Sometimes when delivering projects to clients, they might not be familiar with Markdown or might not have the necessary tools to render it. Online converters often don't replicate the GitHub styling, and might not support dark/light modes. `MDHUB` fills this gap by providing a simple tool to convert Markdown files to styled HTML that resembles GitHub's own rendering, with support for both dark and light themes.
### The name
The name "mdhub" is a nod to the central theme of our tool – making your Markdown files look and feel like they're on GitHub. "md" stands for Markdown, and "hub" alludes to a central place or repository, reminiscent of GitHub where a lot of Markdown content is commonly hosted and viewed. Our goal is to bring that familiar and stylish GitHub appearance to your Markdown files, no matter where they're viewed from, hence the name "mdhub".
## Features
- Converts `.md` files to `.html` with GitHub-like styling.
- Supports both dark and light modes.
- Simple CLI interface for easy use.
## Installation
You can easily install `MDHUB` using pip:
```bash
pip3 install mdhub
```
## Usage
Run the tool using the following command:
```bash
mdhub <inputfile.md (default is README.md)> <optional output file name (default is README.html)> <light or dark mode (default is dark)>
```
For example, to convert `sample.md` to `output.html` in dark mode:
```bash
mdhub sample.md output.html
```
Or to convert `README.md` to `README.html` in dark mode (using default values):
```bash
mdhub
```
## My links
- [Medium Article](https://medium.com/@glizzykingdreko/ad-blockers-are-allowed-on-youtube-40a040a2d039?postPublishedType=initial)
- [Website](https://glizzykingdreko.github.io/)
- [GitHub](https://github.com/glizzykingdreko)
- [Twitter](https://mobile.twitter.com/glizzykingdreko)
- [Medium](https://medium.com/@glizzykingdreko)
- [Email](mailto:glizzykingdreko@protonmail.com)
Raw data
{
"_id": null,
"home_page": "",
"name": "mdhub",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "GlizzyKingDreko",
"author_email": "glizzykingdreko@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/e4/8b/2aac9ac3c5c873ec01d6094028adf98362e353b8629c88171fe995938ad5/mdhub-0.1.1.tar.gz",
"platform": null,
"description": "# MDHub\n\n\n\n \n\nEasily convert Markdown files to styled HTML. Perfect for delivering projects to clients who might not be familiar with `.md` files.\n\n## Table of Contents\n- [MDHub](#mdhub)\n - [Table of Contents](#table-of-contents)\n - [Why MDHUB?](#why-mdhub)\n - [The name](#the-name)\n - [Features](#features)\n - [Installation](#installation)\n - [Usage](#usage)\n - [My links](#my-links)\n\n## Why MDHUB?\n\nSometimes when delivering projects to clients, they might not be familiar with Markdown or might not have the necessary tools to render it. Online converters often don't replicate the GitHub styling, and might not support dark/light modes. `MDHUB` fills this gap by providing a simple tool to convert Markdown files to styled HTML that resembles GitHub's own rendering, with support for both dark and light themes.\n\n### The name\nThe name \"mdhub\" is a nod to the central theme of our tool \u2013 making your Markdown files look and feel like they're on GitHub. \"md\" stands for Markdown, and \"hub\" alludes to a central place or repository, reminiscent of GitHub where a lot of Markdown content is commonly hosted and viewed. Our goal is to bring that familiar and stylish GitHub appearance to your Markdown files, no matter where they're viewed from, hence the name \"mdhub\".\n\n## Features\n\n- Converts `.md` files to `.html` with GitHub-like styling.\n- Supports both dark and light modes.\n- Simple CLI interface for easy use.\n\n## Installation\n\nYou can easily install `MDHUB` using pip:\n\n```bash\npip3 install mdhub\n```\n\n## Usage\nRun the tool using the following command:\n```bash\nmdhub <inputfile.md (default is README.md)> <optional output file name (default is README.html)> <light or dark mode (default is dark)>\n```\n\nFor example, to convert `sample.md` to `output.html` in dark mode:\n```bash\nmdhub sample.md output.html\n```\n\nOr to convert `README.md` to `README.html` in dark mode (using default values):\n```bash\nmdhub\n```\n\n## My links\n\n- [Medium Article](https://medium.com/@glizzykingdreko/ad-blockers-are-allowed-on-youtube-40a040a2d039?postPublishedType=initial)\n- [Website](https://glizzykingdreko.github.io/)\n- [GitHub](https://github.com/glizzykingdreko)\n- [Twitter](https://mobile.twitter.com/glizzykingdreko)\n- [Medium](https://medium.com/@glizzykingdreko)\n- [Email](mailto:glizzykingdreko@protonmail.com)\n",
"bugtrack_url": null,
"license": "",
"summary": "Convert Markdown files to styled HTML with a GitHub-like appearance. Easily switch between light and dark modes.",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ff5cf600512532232b83d8029dcfc577a3806c0381140d5dc79c52020e1b320b",
"md5": "7e475a70fc3186082947eb9218ecb877",
"sha256": "d361d15f311435717fd4c20d5c54b3c537447992649669210cdcd35944730716"
},
"downloads": -1,
"filename": "mdhub-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7e475a70fc3186082947eb9218ecb877",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6504,
"upload_time": "2023-11-05T21:00:54",
"upload_time_iso_8601": "2023-11-05T21:00:54.160098Z",
"url": "https://files.pythonhosted.org/packages/ff/5c/f600512532232b83d8029dcfc577a3806c0381140d5dc79c52020e1b320b/mdhub-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e48b2aac9ac3c5c873ec01d6094028adf98362e353b8629c88171fe995938ad5",
"md5": "bd5baae36508f086df7b69ad6dcc0d6e",
"sha256": "a746d801ec113c240a17a00f41e6e29b829c6bf00f9df0a1ae1377d6a7fb989c"
},
"downloads": -1,
"filename": "mdhub-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "bd5baae36508f086df7b69ad6dcc0d6e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5219,
"upload_time": "2023-11-05T21:00:56",
"upload_time_iso_8601": "2023-11-05T21:00:56.893546Z",
"url": "https://files.pythonhosted.org/packages/e4/8b/2aac9ac3c5c873ec01d6094028adf98362e353b8629c88171fe995938ad5/mdhub-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-05 21:00:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mdhub"
}
