# compileMD
## Brief introduction
Markdown files are a popular format for technical project documentation, but as the amount of docu grows, the files can become long and difficult to manage. The solution to this problem is to break down the markdown file into smaller, more manageable seperate `.md` files and then compile them into a single file i.e., `README.md`. Hence, `compileMD` tries to solve this problem.
<b>compileMD compile markdown files into the single README.md.</b>
## Installation
```bash
$ pip3 install --user compileMD
```
## How to use `compileMD`?
For simplicity, create the following folders and files:
```bash
$ mkdir testing
[ testing]$ mkdir md_docs
```
```
[ md_docs]$ vi 00_intro.md
# Project Title
A brief description of what this project does and who it's for.
```
```
[ md_docs]$ vi 01_installation.md
## Installation
Install my-project with npm ...
```
Now, run compileMD:
```
[ testing]$ compileMD
[info] Compiling 00_intro.md into ./README.md
[info] Compiling 01_installation.md into ./README.md
```
`testing` tree looks like this:
```
.
├── md_docs
│ ├── 00_intro.md
│ ├── 01_installation.md
└── README.md
```
## Related
Here are some related links for this repo:
- [https://pypi.org/project/compileMD](https://pypi.org/project/compileMD)
- [Article > How to publish a PIP package?](https://amaharjan.de/how-to-publish-a-pip-package/)
- [Original/first article](https://github.com/asis2016/amaharjande/tree/main/organize-markdown-with-python)
## Contributing
Contributions are always welcome! Please contact hello@amaharjan.de.
## License
[MIT](./LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/asis2016/compileMD",
"name": "compileMD",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,markdown",
"author": "Ashish S. Maharjan",
"author_email": "<hello@amaharjan.de>",
"download_url": "https://files.pythonhosted.org/packages/25/03/6d9b7246ef1e17af59623f7c18d47560374ae55ac9441803d5de3aa0f2cc/compileMD-0.2.1.tar.gz",
"platform": null,
"description": "# compileMD\n\n## Brief introduction\nMarkdown files are a popular format for technical project documentation, but as the amount of docu grows, the files can become long and difficult to manage. The solution to this problem is to break down the markdown file into smaller, more manageable seperate `.md` files and then compile them into a single file i.e., `README.md`. Hence, `compileMD` tries to solve this problem.\n\n<b>compileMD compile markdown files into the single README.md.</b>\n\n## Installation\n```bash\n$ pip3 install --user compileMD\n```\n\n## How to use `compileMD`?\n\nFor simplicity, create the following folders and files:\n\n```bash\n$ mkdir testing\n[ testing]$ mkdir md_docs\n```\n\n```\n[ md_docs]$ vi 00_intro.md\n\n# Project Title\nA brief description of what this project does and who it's for.\n```\n\n```\n[ md_docs]$ vi 01_installation.md\n\n## Installation\nInstall my-project with npm ...\n```\n\nNow, run compileMD:\n\n```\n[ testing]$ compileMD\n[info] Compiling 00_intro.md into ./README.md\n[info] Compiling 01_installation.md into ./README.md\n```\n\n`testing` tree looks like this:\n```\n.\n\u251c\u2500\u2500 md_docs\n\u2502 \u251c\u2500\u2500 00_intro.md\n\u2502 \u251c\u2500\u2500 01_installation.md\n\u2514\u2500\u2500 README.md\n```\n\n\n## Related\nHere are some related links for this repo:\n- [https://pypi.org/project/compileMD](https://pypi.org/project/compileMD)\n- [Article > How to publish a PIP package?](https://amaharjan.de/how-to-publish-a-pip-package/)\n- [Original/first article](https://github.com/asis2016/amaharjande/tree/main/organize-markdown-with-python)\n\n\n## Contributing\nContributions are always welcome! Please contact hello@amaharjan.de.\n\n## License\n[MIT](./LICENSE)\n\n\n\n\n\n\n\n\n\n \n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Compiles multiple markdown files into a single README.md",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/asis2016/compileMD"
},
"split_keywords": [
"python",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "304c07d4ed92d8c0b28ea8af16188cb60e8b372040f6ebd2d6e8ebf2afe2bf3b",
"md5": "94ffae0c5240e4e67189097f3d0e88a5",
"sha256": "82568cafc0b8c014c2ec1f468ce05fa6f0bf018cfc88f7461629f7988406aaeb"
},
"downloads": -1,
"filename": "compileMD-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "94ffae0c5240e4e67189097f3d0e88a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2931,
"upload_time": "2023-12-24T09:20:41",
"upload_time_iso_8601": "2023-12-24T09:20:41.148163Z",
"url": "https://files.pythonhosted.org/packages/30/4c/07d4ed92d8c0b28ea8af16188cb60e8b372040f6ebd2d6e8ebf2afe2bf3b/compileMD-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "25036d9b7246ef1e17af59623f7c18d47560374ae55ac9441803d5de3aa0f2cc",
"md5": "c62c3cb662a9f6497f75425330a1ba4d",
"sha256": "39f85e56c71110b9f7fc15c61533d02d21e3dba6913a345980f49f3e08654296"
},
"downloads": -1,
"filename": "compileMD-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "c62c3cb662a9f6497f75425330a1ba4d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2493,
"upload_time": "2023-12-24T09:20:46",
"upload_time_iso_8601": "2023-12-24T09:20:46.915131Z",
"url": "https://files.pythonhosted.org/packages/25/03/6d9b7246ef1e17af59623f7c18d47560374ae55ac9441803d5de3aa0f2cc/compileMD-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-24 09:20:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "asis2016",
"github_project": "compileMD",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "compilemd"
}
JSON
