Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.97 KB

README.md

File metadata and controls

55 lines (39 loc) · 1.97 KB

MarkGen

 __  __            _     ____
|  \/  | __ _ _ __| | __/ ___| ___ _ __
| |\/| |/ _` | '__| |/ / |  _ / _ \ '_ \
| |  | | (_| | |  |   <| |_| |  __/ | | |
|_|  |_|\__,_|_|  |_|\_\\____|\___|_| |_|

✨ Features

  • 📜 Markdown Template Engine: Generate personalized markdown files using Go's powerful template engine.
  • 🔗 GitHub Integration: Fetch recent contributions, pull requests, starred repositories, and more with GitHub API support.
  • 📰 RSS Feed Support: Include content from RSS feeds directly in your markdown files.
  • 📚 GoodReads Integration: Display your book reviews, currently reading books, and more using the GoodReads API.
  • ⚙️ Customizable Templates: Use and modify templates for various use cases, including GitHub profile READMEs.
  • 🔒 Authentication Support: Securely access APIs with environment variables for tokens and credentials.
  • 🛠️ Cross-Platform: Available as binaries for Linux, macOS, and Windows, with support for ARM architectures.
  • 🏗️ Build from Source: Easily build the tool from source with Go 1.16 or higher.
  • 🤖 GitHub Actions Ready: Automate markdown generation GitHub action.
  • 🛠️ Template Helpers: Includes utilities like humanize for timestamps and reverse for slices.

🚀 Installation

Download from latest releases

💡 Usage

Render a template to stdout:

markgen template.tpl

Render to a file:

markgen -write /tmp/output.md template.tpl

🤝 How to contribute

We welcome contributions!

  • Fork this repository;
  • Create a branch with your feature: git checkout -b my-feature;
  • Commit your changes: git commit -m "feat: my new feature";
  • Push to your branch: git push origin my-feature.

Once your pull request has been merged, you can delete your branch.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.