Skip to content

πŸ“œ Generate personalized markdown files with templates, GitHub, RSS, and API integrations using Go.

License

Notifications You must be signed in to change notification settings

trinhminhtriet/markgen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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.