awesome-readme
Read the Docs
Our great sponsors
awesome-readme | Read the Docs | |
---|---|---|
30 | 33 | |
16,961 | 7,872 | |
- | 0.5% | |
6.9 | 9.7 | |
1 day ago | 4 days ago | |
Python | ||
- | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
awesome-readme
- Readme: A Curated List of READMEs
- Awesome Readme: A Curated List of READMEs
-
Hacktoberfest 2023 Update from Maintainer of the user-statistician GitHub Action
About user-statistician
-
Hacktoberfest 2023 Contributors Wanted: Additional Translations for the user-statistician GitHub Action
The user-statistician GitHub Action can generate an SVG with a detailed summary of your activity on GitHub. It is mentioned in the tools section of the awesome README awesome list. The SVG it generates includes general information about you (e.g., year you joined, number of followers, number you are following, most starred repository, etc), information about your repositories (e.g., numbers of stars and forks, etc), information about your contributions (e.g., numbers of commits, issues, PRs, etc), and the distribution of languages within your public repositories.
- Mastering Readme Files
-
Marketing for Developers
If you really want a stellar README.md take a look at some of the examples in awesome-readme for inspiration!
-
How to Create the Best README for Your GitHub Project
Awesome README - A collection of high-quality READMEs from a variety of projects, organized by topic. https://github.com/matiassingers/awesome-readme
-
How to create projects for myself to enrich my resume?
Provide a succinct and comprehensive README: readers of your personal project will always start with the README to know where to begin. The goal of the README is to provide the reader an understanding of the business problem you are trying to solve, how your solution goes about solving it (solution architecture diagram), and how to get started and run your code. There are plenty of great README examples here: https://github.com/matiassingers/awesome-readme
-
Configuring GitHub's Linguist to Improve Repository Language Reporting
About user-statistician
-
The user-statistician GitHub Action mentioned in Awesome-README
Recently, the user-statistician GitHub Action was added to the tools section of Awesome README, which is an Awesome List that includes a curated collection of examples of Awesome READMEs from open source projects, as well as tools enabling creating Awesome READMEs. The Awesome README list is a great place to go if you are looking for ideas for how to improve the READMEs of your open source projects. The Awesome README list covers READMEs more generally, but the tools section includes a few tools focused on Profile READMEs, in addition to many tools for project READMEs more generally. The user-statistician GitHub Action is in the Tools Section.
Read the Docs
-
Ask HN: ReadTheDocs Became Proprietary Now?
I went to https://readthedocs.org/ and redirected me to https://about.readthedocs.com/?ref=readthedocs.org which looks proprietary now, with pricing and such.
Is it the end of this project, as we know it?
Can someone enlighten me please?
-
Quick Guide to Leveraging Read the Docs for Your GitHub Projects
First things first, sign up on Read the Docs and connect your GitHub account. This allows Read the Docs to access your repositories.
-
Exploring Django's Third-Party Packages: Top Libraries You Should Know
ReadTheDocs - ReadTheDocs hosts documentation for many Django packages. It provides easy access to comprehensive documentation, including installation instructions, configuration guides, and usage examples.
-
ReadTheDocs Sphinx theme urllib3 related build errors
fixes are here: https://github.com/readthedocs/readthedocs.org/issues/10290
-
Dealing with documentation
Read the Docs offers free hosting of Sphinx-based documentation. I recommend setting up a basic documentation very early so that you can easily add material when you have something to write about. I also recommend studying The Grand Unified Theory of Documentation, but don't overthink it.
-
Document or Die: The Importance of Writing Things Down in Tech
ReadTheDocs: An open-source platform for creating and hosting documentation, with support for multiple programming languages and integration with version control systems.
-
datadelivery: Providing public datasets to explore in AWS
Well, by now I really invite all the readers to join and read more about the datadelivery Terraform module. There is a huge documentation page hosted on readthedocs with many useful information about how this project can help users on their analytics journey in AWS.
-
Marketing for Developers
ReadTheDocs is a free way to host your open-source documentation.
-
Re-License Vaultwarden to AGPLv3
They are using this infrastructure as the moat. ReadTheDocs is also doing the same thing.
Deploy if you dare: https://github.com/readthedocs/readthedocs.org
-
Yahoo is making a return to search
That "/*/tree" rule means that search engine crawlers are allowed to hit the README file of a repo but effectively NONE of the other files in it.
Which means that if you keep your project documentation on GitHub in a docs/ folder it won't be indexed!
You need to publish it to a separate site via GitHub Pages, or use https://readthedocs.org/
What are some alternatives?
revo-grid - Powerful virtual data grid smartsheet with advanced customization. Best features from excel plus incredible performance 🔋
MkDocs - Project documentation with Markdown.
Konva - Konva.js is an HTML5 Canvas JavaScript framework that extends the 2d context by enabling canvas interactivity for desktop and mobile applications.
mkdocs-material - Documentation that simply works
Apache AGE - Graph database optimized for fast analysis and real-time data processing. It is provided as an extension to PostgreSQL. [Moved to: https://github.com/apache/age]
just-the-docs - A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
amplify-cli - The AWS Amplify CLI is a toolchain for simplifying serverless web and mobile development.
MdWiki
spring-rest-crud-example - Use this repository as a basis to start the development of a new Java REST API.
Hugo - The world’s fastest framework for building websites.
minio-py - MinIO Client SDK for Python
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js