/docwiz

🚀 CLI that generates beautiful git files

Primary LanguageGoMIT LicenseMIT

Welcome to docwiz 👋

BashScript Go PowerShell

English | 简体中文

DocWiz is a versatile command-line tool that helps generate various types of project documentation like README, LICENSE, ROADMAP, CONTRIBUTORS, and more. It leverages templates and user inputs to create customized and professional documentation files.

📦 Install

build by yourself

git clone git@github.com:Ansurfen/docwiz.git
cd ./docwiz

# method 1: using goreleaser
goreleaser release --snapshot --clean

# method 2: using goreleaser, aliax
aliax release

download

You can download the binary version here.

🚀 Usage

Note

The details are viewed using docwiz -h

readme

Automatic scanning technology stack generation (✨RECOMMEND) readme_s

Based on TUI to generate readme_s

changelog

docwiz changelog

contributor

docwiz contributors

gitignore

gitignore

license

license

commit

Commit

copyright

copyright

roadmap

docwiz roadmap

🤝 Contributing

Contributions, issues and feature requests are welcome.
Feel free to check issues page if you want to contribute.
Check the contributing guide.

📝 License

This software is licensed under the MIT license, see LICENSE for more information.

This Markdown was generated with ❤️ by docwiz