Skip to content

Commit

Permalink
Rename project 'catalog' (#92)
Browse files Browse the repository at this point in the history
- less intimidating for people who would like to add their project
- it's going to be used as a catalog by MkDocs
  • Loading branch information
pawamoy authored Jun 4, 2023
1 parent 35ff523 commit 7c9f54f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions config/footer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@

Contributions are encouraged and always welcome! If you like to add or update projects, choose one of the following ways:

- Open an issue by selecting one of the provided categories from the [issue page](https://github.com/pawamoy/best-of-mkdocs/issues/new/choose) and fill in the requested information.
- Modify the [projects.yaml](https://github.com/pawamoy/best-of-mkdocs/blob/main/projects.yaml) with your additions or changes, and submit a pull request. This can also be done directly via the [Github UI](https://github.com/pawamoy/best-of-mkdocs/edit/main/projects.yaml).
- Open an issue by selecting one of the provided categories from the [issue page](https://github.com/mkdocs/catalog/issues/new/choose) and fill in the requested information.
- Modify the [projects.yaml](https://github.com/mkdocs/catalog/blob/main/projects.yaml) with your additions or changes, and submit a pull request. This can also be done directly via the [Github UI](https://github.com/mkdocs/catalog/edit/main/projects.yaml).

If you like to contribute to or share suggestions regarding the project metadata collection or markdown generation, please refer to the [best-of-generator](https://github.com/best-of-lists/best-of-generator) repository. If you like to create your own best-of list, we recommend to follow [this guide](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md).

For more information on how to add or update projects, please read the [contribution guidelines](https://github.com/pawamoy/best-of-mkdocs/blob/main/CONTRIBUTING.md). By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/pawamoy/best-of-mkdocs/blob/main/.github/CODE_OF_CONDUCT.md).
For more information on how to add or update projects, please read the [contribution guidelines](https://github.com/mkdocs/catalog/blob/main/CONTRIBUTING.md). By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/mkdocs/catalog/blob/main/.github/CODE_OF_CONDUCT.md).

## License

Expand Down
8 changes: 4 additions & 4 deletions config/header.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<!-- markdownlint-disable -->
<h1 align="center">
best-of-mkdocs
catalog
<br>
</h1>

<p align="center">
<strong>:trophy: :books: A ranked list of awesome <a href="https://github.com/mkdocs/mkdocs">MkDocs</a> projects and plugins.</strong>
<strong>:trophy: :books: A list of awesome <a href="https://github.com/mkdocs/mkdocs">MkDocs</a> projects and plugins.</strong>
</p>

<p align="center">
<a href="https://best-of.org" title="Best-of Badge"><img src="http://bit.ly/3o3EHNN"></a>
<a href="#Contents" title="Project Count"><img src="https://img.shields.io/badge/projects-{project_count}-blue.svg?color=5ac4bf"></a>
<a href="#Contribution" title="Contributions are welcome"><img src="https://img.shields.io/badge/contributions-welcome-green.svg"></a>
<a href="https://github.com/pawamoy/best-of-mkdocs/releases" title="Best-of Updates"><img src="https://img.shields.io/github/release-date/pawamoy/best-of-mkdocs?color=green&label=updated"></a>
<a href="https://github.com/mkdocs/catalog/releases" title="Catalog Updates"><img src="https://img.shields.io/github/release-date/mkdocs/catalog?color=green&label=updated"></a>
</p>

This curated list contains {project_count} awesome open-source projects with a total of {stars_count} stars grouped into {category_count} categories. All projects are ranked by a project-quality score, which is calculated based on various metrics automatically collected from GitHub and different package managers. If you like to add or update projects, feel free to open an [issue](https://github.com/pawamoy/best-of-mkdocs/issues/new/choose), submit a [pull request](https://github.com/pawamoy/best-of-mkdocs/pulls), or directly edit the [projects.yaml](https://github.com/pawamoy/best-of-mkdocs/edit/main/projects.yaml). Contributions are very welcome!
This list contains {project_count} awesome open-source projects with a total of {stars_count} stars grouped into {category_count} categories. All projects are ranked by a project-quality score, which is calculated based on various metrics automatically collected from GitHub and different package managers. If you want to add or update projects, feel free to open an [issue](https://github.com/mkdocs/catalog/issues/new/choose), submit a [pull request](https://github.com/mkdocs/catalog/pulls), or directly edit the [projects.yaml](https://github.com/mkdocs/catalog/edit/main/projects.yaml). Contributions are very welcome!

> 🧙‍♂️ Discover other [best-of lists](https://best-of.org) or [create your own](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md).

0 comments on commit 7c9f54f

Please sign in to comment.