{"id":18068000,"url":"https://github.com/luisvent/document_my_project","last_synced_at":"2025-03-28T12:30:44.074Z","repository":{"id":230751102,"uuid":"780077594","full_name":"luisvent/document_my_project","owner":"luisvent","description":"Easily create markdown documentation for your project (WIP)","archived":false,"fork":false,"pushed_at":"2024-10-29T14:41:23.000Z","size":2617,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-31T08:02:59.478Z","etag":null,"topics":["ai","angular","documentation","generate","markdown","ngrx","project","tailwindcss"],"latest_commit_sha":null,"homepage":"https://documentmyproject.lv-apps.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luisvent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-31T16:32:53.000Z","updated_at":"2024-10-29T14:42:19.000Z","dependencies_parsed_at":"2024-04-16T00:36:48.801Z","dependency_job_id":"6465fb44-b081-4bf6-a321-fb381eb7a1bc","html_url":"https://github.com/luisvent/document_my_project","commit_stats":null,"previous_names":["luisvent/document_my_project"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luisvent%2Fdocument_my_project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luisvent%2Fdocument_my_project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luisvent%2Fdocument_my_project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luisvent%2Fdocument_my_project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luisvent","download_url":"https://codeload.github.com/luisvent/document_my_project/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246030125,"owners_count":20712323,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","angular","documentation","generate","markdown","ngrx","project","tailwindcss"],"created_at":"2024-10-31T08:01:02.543Z","updated_at":"2025-03-28T12:30:42.500Z","avatar_url":"https://github.com/luisvent.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n\n\u003ca href=\"https://devhunt.org/tool/document-my-project\" title=\"Go to DevHunt\"\u003e\n\u003cimg width=\"196px\" alt=\"Document My Project\" src=\"./docs/devhunt_badge.png\"\u003e\n\u003c/a\u003e\n\n\u003c/p\u003e\n\n\n\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\u003c!--\n*** Thanks for using Document My Project. (https://github.com/luisvent/document_my_project) \n*** If you have a suggestion that would make this better, please fork  \n*** the repo and create a pull request or simply open an issue.\n*** Don't forget to give the project a star!\n--\u003e\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://github.com/luisvent/document_my_project/graphs/contributors\"\u003e\u003cimg src=\"https://img.shields.io/github/contributors/luisvent/document_my_project.svg?style=for-the-badge\" alt=\"Contributors\"\u003e\u003c/a\u003e\n        \u003ca href=\"https://github.com/luisvent/document_my_project/network/members\"\u003e\u003cimg src=\"https://img.shields.io/github/forks/luisvent/document_my_project.svg?style=for-the-badge\" alt=\"Forks\"\u003e\u003c/a\u003e\n        \u003ca href=\"https://github.com/luisvent/document_my_project/stargazers\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/luisvent/document_my_project.svg?style=for-the-badge\" alt=\"Stargazers\"\u003e\u003c/a\u003e\n        \u003ca href=\"https://github.com/luisvent/document_my_project/issues\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/luisvent/document_my_project.svg?style=for-the-badge\" alt=\"Issues\"\u003e\u003c/a\u003e\u003c/p\u003e\u003cbr/\u003e\n\n\n\u003cdiv align=\"center\"\u003e\n\n\u003ca href=\"\" target=\"_blank\" title=\"Go to  website\"\u003e\n\u003cimg width=\"196px\" alt=\"Document My Project\" src=\"./docs/icon.png\"\u003e\n\u003c/a\u003e\n\n# Document My Project\n\nEasily create markdown documentation for your project\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\u003ch4\u003e\u003ca href=\"#-about-the-project\"\u003eℹ️ About the Project\u003c/a\u003e • \u003ca href=\"#-showcase\"\u003e🏞 Showcase\u003c/a\u003e • \u003ca href=\"#-features\"\u003e⭐️ Features\u003c/a\u003e • \u003ca href=\"#-stack-tech\"\u003e🛠 Stack Tech\u003c/a\u003e • \u003ca href=\"#-setup\"\u003e⚙ ️Setup\u003c/a\u003e • \u003ca href=\"#-acknowledgements\"\u003e🏆 Acknowledgements\u003c/a\u003e • \u003ca href=\"#-contributing\"\u003e👏🏻 Contributing\u003c/a\u003e • \u003ca href=\"#-about-the-author\"\u003e👨🏻‍ About the Author\u003c/a\u003e • \u003ca href=\"#-license\"\u003e📖 License\u003c/a\u003e\u003c/h4\u003e\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"./docs/dmp_1.png\" alt=\"Main Image\"/\u003e\u003c/p\u003e\n\n## ️Table of Contents\n\n \u003cdetails\u003e\n\u003csummary\u003eOpen Contents\u003c/summary\u003e\n\n- [Document My Project](#document-my-project)\n    - [ℹ️ About the Project](#-about-the-project)\n    - [🏞 Showcase](#-showcase)\n    - [⭐️ Features](#-features)\n    - [🛠 Stack Tech](#-stack-tech)\n    - [⚙ ️Setup](#-setup)\n        - [Installation](#installation)\n        - [Usage](#usage)\n    - [🏆 Acknowledgements](#-acknowledgements)\n    - [👏🏻 Contributing](#-contributing)\n        - [Ways to Contribute](#ways-to-contribute)\n        - [Contribution Instructions](#contribution-instructions)\n        - [Contributors](#contributors)\n    - [👨🏻‍ About the Author](#-about-the-author)\n    - [📖 License](#-license)\n\n\u003c/details\u003e\n\n## ℹ️ About the Project\n\nTired of manually writing README files? this tool simplifies the process of creating documentation for Github projects.\nWith just a few clicks, you can generate comprehensive documentation that enhances the visibility and usability of your\nrepositories in seconds.\n\n## 🏞 Showcase\n\n \u003ccenter\u003e\n\n\u003ctable\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ca href=\"./docs/dmp_s_1.png\"\u003e\u003cimg width=\"320\" src=\"./docs/dmp_s_1.png\"\u003e\u003c/a\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ca href=\"./docs/dmp_s_2.png\"\u003e\u003cimg width=\"320\" src=\"./docs/dmp_s_2.png\"\u003e\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003ca href=\"./docs/dmp_s_3.png\"\u003e\u003cimg width=\"320\" src=\"./docs/dmp_s_3.png\"\u003e\u003c/a\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ca href=\"./docs/dmp_s_4.png\"\u003e\u003cimg width=\"320\" src=\"./docs/dmp_s_4.png\"\u003e\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c/center\u003e\n\n## ⭐️ Features\n\n1. **Template ready**\n\nProvide a clear and concise description of your project, highlight the main features, goals, and benefits of your\nproject\n\n2. **Ease fo use**\n\nEasily generate a well-structured README file for your GitHub project\n\n3. **Preview**\n\nPreview the generated README (light/dark theme) file before committing it to your repository\n\n## 🛠 Stack Tech\n\n- [![Angular][Angular-badge]][Angular-url] - A front-end web application framework\n\n[Angular-badge]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge\u0026logo=angular\n\n[Angular-url]: }\n\n- [![NgRx][NgRx-badge]][NgRx-url] - Angular state management based on Redux\n\n[NgRx-badge]: https://img.shields.io/badge/NgRx-B7116E?style=for-the-badge\u0026logo=ngrx\n\n[NgRx-url]: }\n\n- [![Tailwind CSS][Tailwind CSS-badge]][Tailwind CSS-url] - Utility-first CSS framework\n\n[Tailwind CSS-badge]: https://img.shields.io/badge/Tailwind%20CSS-38B2AC?style=for-the-badge\u0026logo=tailwindcss\n\n[Tailwind CSS-url]: }\n\n- [![TypeScript][TypeScript-badge]][TypeScript-url] - A strict syntactical superset of JavaScript\n\n[TypeScript-badge]: https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge\u0026logo=typescript\n\n[TypeScript-url]: }\n\n## ⚙ ️Setup\n\n### Installation\n\nTo install this project, follow these steps:\n\n1. Install Node.js v16 or later\n\n2. Install the required dependencies:\n\n3. `npm install`\n\n### Usage\n\nAfter installation, you can use the project by following these steps:\n\n1. Open the project directory in your code editor\n\n2. Run `npm run start` to start the development server\n\n## 🏆 Acknowledgements\n\n- [ngx-markdown](https://www.npmjs.com/package/ngx-markdown) - Angular markdown component/directive/pipe/service to\n  parse static, dynamic or remote content to HTML with syntax highlight and more\n- [Flowbite](https://flowbite.com/) - Build websites even faster with components on top of Tailwind CSS\n- [PrismJs](https://prismjs.com/) - Prism is a lightweight, extensible syntax highlighter, built with modern web\n  standards in mind. It’s used in millions of websites, including some of those you visit daily.\n\n## 👏🏻 Contributing\n\nWe welcome contributions from the community! If you would like to contribute to this project, please follow the\nguidelines below.\n\n### Ways to Contribute\n\n- Report bugs or issues by opening a new issue on our GitHub repository.\n- Suggest new features or improvements by opening a new issue on our GitHub repository.\n- Contribute code by forking the repository, making changes, and submitting a pull request.\n\n### Contribution Instructions\n\n1. Fork the repository.\n2. Create a new branch for your feature or bug fix: `git checkout -b my-feature-branch`.\n3. Make the necessary changes and commit them: `git commit -am 'Add my new feature'`.\n4. Push your branch to your forked repository: `git push origin my-feature-branch`.\n5. Open a pull request against the main repository, describing the changes you made and why they should be merged.\n\n### Contributors\n\n- Luis Ventura (@luisvent)\n\n## 👨🏻‍ About the Author\n\n**Luis Ventura**\n\nThis project was created by Luis Ventura. Connect with me on [GitHub](https://github.com/luisvent)\nand [LinkedIn](https://www.linkedin.com/in/luisvent/) to learn more about my projects and professional background.\n\n## 📖 License\n\nThis project is licensed under the [MIT License](https://opensource.org/licenses/MIT).\n\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eTop ⬆️\u003c/a\u003e\u003c/p\u003e\n\n---\n \u003cdiv align=\"center\"\u003eBuilt with ❤️ with \u003ca href=\"https://github.com/luisvent/document_my_project\"\u003eDocument My Project\u003c/a\u003e\u003c/div\u003e\n\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluisvent%2Fdocument_my_project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluisvent%2Fdocument_my_project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluisvent%2Fdocument_my_project/lists"}