Document My Project

Easily create markdown documentation for your project

ℹ️ About the Project • 🏞 Showcase • ⭐️ Features • 🛠 Stack Tech • ⚙ ️Setup • 🏆 Acknowledgements • 👏🏻 Contributing • 👨🏻‍ About the Author • 📖 License

️Table of Contents

Open Contents

• Document My Project
  • ℹ️ About the Project
  • 🏞 Showcase
  • ⭐️ Features
  • 🛠 Stack Tech
  • ⚙ ️Setup
    • Installation
    • Usage
  • 🏆 Acknowledgements
  • 👏🏻 Contributing
    • Ways to Contribute
    • Contribution Instructions
    • Contributors
  • 👨🏻‍ About the Author
  • 📖 License

ℹ️ About the Project

Tired of manually writing README files? this tool simplifies the process of creating documentation for Github projects. With just a few clicks, you can generate comprehensive documentation that enhances the visibility and usability of your repositories in seconds.

🏞 Showcase

⭐️ Features

1. Template ready

Provide a clear and concise description of your project, highlight the main features, goals, and benefits of your project

2. Ease fo use

Easily generate a well-structured README file for your GitHub project

3. Preview

Preview the generated README (light/dark theme) file before committing it to your repository

🛠 Stack Tech

• - A front-end web application framework

• - Angular state management based on Redux

• - Utility-first CSS framework

• - A strict syntactical superset of JavaScript

⚙ ️Setup

Installation

To install this project, follow these steps:

1. Install Node.js v16 or later

2. Install the required dependencies:

3. npm install

Usage

After installation, you can use the project by following these steps:

1. Open the project directory in your code editor

2. Run npm run start to start the development server

🏆 Acknowledgements

• ngx-markdown - Angular markdown component/directive/pipe/service to parse static, dynamic or remote content to HTML with syntax highlight and more
• Flowbite - Build websites even faster with components on top of Tailwind CSS
• PrismJs - Prism is a lightweight, extensible syntax highlighter, built with modern web standards in mind. It’s used in millions of websites, including some of those you visit daily.

👏🏻 Contributing

We welcome contributions from the community! If you would like to contribute to this project, please follow the guidelines below.

Ways to Contribute

• Report bugs or issues by opening a new issue on our GitHub repository.
• Suggest new features or improvements by opening a new issue on our GitHub repository.
• Contribute code by forking the repository, making changes, and submitting a pull request.

Contribution Instructions

1. Fork the repository.
2. Create a new branch for your feature or bug fix: git checkout -b my-feature-branch.
3. Make the necessary changes and commit them: git commit -am 'Add my new feature'.
4. Push your branch to your forked repository: git push origin my-feature-branch.
5. Open a pull request against the main repository, describing the changes you made and why they should be merged.

Contributors

• Luis Ventura (@luisvent)

👨🏻‍ About the Author

Luis Ventura

This project was created by Luis Ventura. Connect with me on GitHub and LinkedIn to learn more about my projects and professional background.

📖 License

This project is licensed under the MIT License.

Top ⬆️

---

Built with ❤️ with Document My Project