Go Readme to Blog
Sync project README.md to Hugo blog post.
- Directory mode
Pair files in a blog(markdown) directory, with repository name in another folder. If the split-marker is found in blog and readme, it combines top(before marker) from blog and bottom(after marker) from readme file, and output to a new location.
Check split and skip markers in files inside folders.
Output paring result only.
- File mode
If the split-marker is found in blog and readme, it combines top(before marker) from blog and bottom(after marker) from readme file, and output to a new location.
Check split and skip markers in files.
Example: Check README.md to blog paring
Example: Directory mode sync README.md to blog
- Feature complete
The MIT License
Copyright (c) 2022 John Siu
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.