|
| 1 | +<!--- Source file(s) of this README: --> |
| 2 | +<!--- |
| 3 | +Markdown: input: "_readme_blueprint.md" |
| 4 | +JSON: input config: "_readme_blueprint.json" |
| 5 | +JSON: config data: "config_data.json" |
| 6 | +JSON: package: "package.json" --> |
| 7 | + |
| 8 | + |
| 9 | +<br /> |
| 10 | +<div align="center"> |
| 11 | + <a href="https://github.com/renhong-zhang/enhanced-markdown-generator"> |
| 12 | + <img height="150px" src="https://img.shields.io/badge/-mdgen-008BD0?&logo=Markdown&logoColor=fed001" alt="Logo"> |
| 13 | + </a> |
| 14 | + |
| 15 | + <h3 align="center">@renhong-zhang/enhanced-markdown-generator</h3> |
| 16 | + |
| 17 | + <p align="center"> |
| 18 | + <b>Automatically generate a beautiful best-practice Markdown file based on the contents of your repository, such as README.md, and other files include Markdown, SVG, or HTML files with customized template</b></br> |
| 19 | + <sub>Temp Abstract<sub> |
| 20 | + <br> |
| 21 | + <a href="[-- asset.doc.link --]"><strong>Explore enhanced-markdown-generator Docs »</strong></a> |
| 22 | + <br> |
| 23 | + <br> |
| 24 | + <a href="https://github.com/renhong-zhang/enhanced-markdown-generator#Demo">View Demo</a> |
| 25 | + · |
| 26 | + <a href="https://github.com/renhong-zhang/enhanced-markdown-generator/issues/new?assignees=-&labels=bug&template=bug_report.yml">Report |
| 27 | + bug</a> |
| 28 | + · |
| 29 | + <a href="https://github.com/renhong-zhang/enhanced-markdown-generator/issues/new?assignees=&labels=feature&template=feature_request.yml">Request |
| 30 | + feature</a> |
| 31 | + </p> |
| 32 | +</div> |
| 33 | + |
| 34 | +<p align="left"> |
| 35 | +<table border="0" width="100%" id="badge" cellspacing="0" cellpadding="0"> |
| 36 | + <tr> |
| 37 | + <td>Prerequisites</td> |
| 38 | + <td><a href="#"><img alt="npm" src="https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white&style=flat" height="20" /></a></td> |
| 39 | + </tr> |
| 40 | + <tr> |
| 41 | + <td>Languages & Tools</td> |
| 42 | + <td><a href="#"><img alt="TypeScript" src="https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white&style=flat" height="20" /></a> <a href="#"><img alt="Markdown" src="https://img.shields.io/badge/Markdown-000000?logo=markdown&logoColor=white&style=flat" height="20" /></a></td> |
| 43 | + </tr> |
| 44 | + <tr> |
| 45 | + <td>License</td> |
| 46 | + <td><a href="https://opensource.org/licenses/GPL-3.0"><img alt="License: GNU GPL v3.0" src="https://img.shields.io/badge/License-GNU%20GPL%20v3.0-yellow?&style=plastic" height="20" /></a></td> |
| 47 | + </tr> |
| 48 | + <tr> |
| 49 | + <td>State</td> |
| 50 | + <td><a href="https://github.com/renhong-zhang/enhanced-markdown-generator/graphs/commit-activity"><img alt="Maintained" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg?&style=plastic" height="20" /></a></td> |
| 51 | + </tr> |
| 52 | +</table> |
| 53 | +</p> |
| 54 | + |
| 55 | +<p align="center"><a href="#table-of-contents"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 56 | + |
| 57 | +<details open> |
| 58 | + <summary><big><b>Table of Contents</big></b></summary> |
| 59 | + <ol> |
| 60 | + <li><a href="#demo">Demo</a></li> |
| 61 | +<li><a href="#about-the-project">About The Project</a></li> |
| 62 | +<ul><li><a href="#built-with">Built With</a></li></ul> |
| 63 | +<li><a href="#getting-started">Getting Started</a></li> |
| 64 | +<ul><li><a href="#prerequisites">Prerequisites</a></li></ul> |
| 65 | +<ul><li><a href="#installation">Installation</a></li></ul> |
| 66 | +<li><a href="#usage">Usage</a></li> |
| 67 | +<li><a href="#roadmap">Roadmap</a></li> |
| 68 | +<li><a href="#changelog">Changelog</a></li> |
| 69 | +<li><a href="#code-contributors">Code Contributors</a></li> |
| 70 | +<li><a href="#contributing">Contributing</a></li> |
| 71 | +<li><a href="#author-">Author </a></li> |
| 72 | +<li><a href="#how-can-i-support-you">How can I support you?</a></li> |
| 73 | +<li><a href="#acknowledgments">Acknowledgments</a></li> |
| 74 | +<li><a href="#license">License</a></li> |
| 75 | + </ol> |
| 76 | +</details> |
| 77 | + |
| 78 | +<p align="center"><a href="#demo"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 79 | + |
| 80 | + |
| 81 | + |
| 82 | +## Demo |
| 83 | + |
| 84 | + |
| 85 | +<p align="center"><a href="assets/demo.gif"><img align="center" width="800px" src="assets/demo.gif" alt="demo" /></a></p> |
| 86 | + |
| 87 | +<p align="center"><a href="#about-the-project"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 88 | + |
| 89 | + |
| 90 | + |
| 91 | +## About The Project |
| 92 | + |
| 93 | + |
| 94 | + |
| 95 | + |
| 96 | +### Built With |
| 97 | + |
| 98 | + |
| 99 | +<p align="left"> |
| 100 | +<table border="0" width="100%" id="badge" cellspacing="0" cellpadding="0"> |
| 101 | + <tr> |
| 102 | + <td><b>Major Frameworks/Libraries</b></td> |
| 103 | + <td> |
| 104 | + <a href="#"><img alt="npm" src="https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white&style=flat" height="20" /></a><br><a href="#"><img alt="TypeScript" src="https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white&style=flat" height="20" /></a> |
| 105 | + </td> |
| 106 | + </tr> |
| 107 | +</table> |
| 108 | +</p> |
| 109 | + |
| 110 | +<p align="center"><a href="#getting-started"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | +## Getting Started |
| 115 | + |
| 116 | + |
| 117 | + |
| 118 | + |
| 119 | +### Prerequisites |
| 120 | + |
| 121 | + |
| 122 | + |
| 123 | + |
| 124 | +### Installation |
| 125 | + |
| 126 | + |
| 127 | +<p align="center"><a href="#usage"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 128 | + |
| 129 | + |
| 130 | + |
| 131 | +## Usage |
| 132 | + |
| 133 | + |
| 134 | +_For more usages and examples, please refer to the [Documentation]([-- asset.doc.link --])_ |
| 135 | + |
| 136 | +<p align="center"><a href="#roadmap"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 137 | + |
| 138 | + |
| 139 | + |
| 140 | +## Roadmap |
| 141 | + |
| 142 | + |
| 143 | +- [ ] Nested Load Files in `blueprint` |
| 144 | +- [ ] Support run Script and Command in JSON file, with not only shell script supported |
| 145 | +- [ ] Support Base-64 Conversion, so that exteranl svg could be embedded to badges |
| 146 | + |
| 147 | +See the [open issues](https://github.com/renhong-zhang/enhanced-markdown-generator/issues) for a full list of proposed features (and known issues). |
| 148 | + |
| 149 | +<p align="center"><a href="#changelog"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 150 | + |
| 151 | + |
| 152 | + |
| 153 | +## Changelog |
| 154 | + |
| 155 | + |
| 156 | +Detailed changes for each release are documented in the [release notes](https://github.com/renhong-zhang/enhanced-markdown-generator/releases). |
| 157 | + |
| 158 | +<p align="center"><a href="#code-contributors"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 159 | + |
| 160 | + |
| 161 | + |
| 162 | +## Code Contributors |
| 163 | + |
| 164 | +Thank you to all the people who already contributed to Enhanced Markdown Generator! |
| 165 | +<a href="https://github.com/renhong-zhang/enhanced-markdown-generator/contributors"><img |
| 166 | + src="https://opencollective.com/enhanced-markdown-generator/contributors.svg?width=890" /></a> |
| 167 | + |
| 168 | +<p align="center"><a href="#contributing"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 169 | + |
| 170 | + |
| 171 | + |
| 172 | +## Contributing |
| 173 | + |
| 174 | + |
| 175 | +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". |
| 176 | + |
| 177 | +<br> |
| 178 | +<div align="center"> |
| 179 | + <a href="https://github.com/renhong-zhang/enhanced-markdown-generator/blob/dev/.github/CONTRIBUTING.md"><img alt="Contributing Guide" width="40%" |
| 180 | + src="https://img.shields.io/badge/Guide-CONTRIBUTE%20NOW!-success"></a> |
| 181 | +</div> |
| 182 | +<br> |
| 183 | + |
| 184 | +1. Fork the Project |
| 185 | +2. Create your Feature Branch (`git checkout -b feature/NewFeature`) |
| 186 | +3. Commit your Changes (`git commit -m 'Add some NewFeature'`) |
| 187 | +4. Push to the Branch (`git push origin feature/NewFeature`) |
| 188 | +5. Open a Pull Request |
| 189 | + |
| 190 | +<p align="center"><a href="#author-"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 191 | + |
| 192 | + |
| 193 | + |
| 194 | +## Author |
| 195 | + |
| 196 | +<p align="left"> |
| 197 | +<table border="0" width="100%" style="margin: 0px;" id="badge" cellspacing="0"> |
| 198 | + <tr> |
| 199 | + <td width="20%"> |
| 200 | + <a href="https://github.com/renhong-zhang"><img width="100%" align="top-left" |
| 201 | + src="https://github.com/renhong-zhang.png?size=512" alt="demo" id="avatar" /></a> |
| 202 | + </td> |
| 203 | + <td><big><b>Renhong Zhang</b></big> |
| 204 | + <br> |
| 205 | + Github: <a href="https://github.com/renhong-zhang">@renhong-zhang</a> |
| 206 | + </td> |
| 207 | + </tr> |
| 208 | +</table> |
| 209 | +</p> |
| 210 | + |
| 211 | +<p align="center"><a href="#how-can-i-support-you"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 212 | + |
| 213 | + |
| 214 | + |
| 215 | +## How can I support you? |
| 216 | + |
| 217 | + |
| 218 | +There are lots of ways to support me! I would be so happy if you give any of my repositories a ⭐️, and tell your friends about this little corner of the Internet |
| 219 | + |
| 220 | +<p align="center"><a href="#acknowledgments"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 221 | + |
| 222 | + |
| 223 | + |
| 224 | +## Acknowledgments |
| 225 | + |
| 226 | + |
| 227 | +<p align="center"><a href="#license"><img align="center" width="100%" height="5px" src="assets/line.svg"/></a></p> |
| 228 | + |
| 229 | + |
| 230 | + |
| 231 | +## License |
| 232 | + |
| 233 | + |
| 234 | + |
| 235 | +[GNU General Public License version 3](https://opensource.org/licenses/GPL-3.0) |
| 236 | + |
| 237 | + |
| 238 | +Copyright © 2023-present, Renhong Zhang |
| 239 | + |
0 commit comments