Open Contents
Fed up with manually creating README files? Try our web app that simplifies the documentation process for GitHub projects. With our user-friendly platform, you can quickly generate detailed and visually appealing Markdown documentation in just seconds.
 |
 |
 |
 |
- Template ready
Provide a clear and concise description of your project, highlight the main features, goals, and benefits of your project
- Ease fo use
Easily generate a well-structured README file for your GitHub project
- Preview
Preview the generated README (light/dark theme) file before committing it to your repository
- A front-end web application framework
- Angular state management based on Redux
- Utility-first CSS framework
- A strict syntactical superset of JavaScript
To install this project, follow these steps:
-
Install Node.js v16 or later
-
Install the required dependencies:
-
npm install
After installation, you can use the project by following these steps:
-
Open the project directory in your code editor
-
Run
npm run startto start the development server
- 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.
We welcome contributions from the community! If you would like to contribute to this project, please follow the guidelines below.
- 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.
- Fork the repository.
- Create a new branch for your feature or bug fix:
git checkout -b my-feature-branch. - Make the necessary changes and commit them:
git commit -am 'Add my new feature'. - Push your branch to your forked repository:
git push origin my-feature-branch. - Open a pull request against the main repository, describing the changes you made and why they should be merged.
- Hazel Granados (hazeliscoding)
Hazel Granados
This project was created by Hazel Granados. Connect with me on GitHub and LinkedIn to learn more about my projects and professional background.
This project is licensed under the MIT License.