https://github.com/asis2016/compilemd
Compile markdown files into the single README.md
https://github.com/asis2016/compilemd
Last synced: 2 months ago
JSON representation
Compile markdown files into the single README.md
- Host: GitHub
- URL: https://github.com/asis2016/compilemd
- Owner: asis2016
- License: mit
- Created: 2023-12-23T06:17:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-24T09:17:09.000Z (over 2 years ago)
- Last Synced: 2024-04-25T13:00:42.930Z (about 2 years ago)
- Language: Python
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
compileMD compile markdown files into the single README.md.
## 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)