From 2afa46d4bc670e48ea356325df4cb819e393fa0e Mon Sep 17 00:00:00 2001 From: atharwa_24 Date: Sat, 1 Aug 2020 00:45:29 +0530 Subject: [PATCH 1/3] update README.md Changes in the README.md for making contribution guidelines visible at a glance on README added license information in the README file --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 58499a2206..9ee2a6c247 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ # Docsy -![GitHub](https://img.shields.io/github/license/google/docsy) Docsy is a [Hugo](https://gohugo.io/) theme for technical documentation sets, providing simple navigation, site structure, and more. @@ -49,3 +48,12 @@ hugo server --themesDir ../.. ``` Note that you need the `themesDir` flag when running Hugo because the site files are inside the theme repo. + +## Contributing + +Please read [CONTRIBUTING.md](https://github.com/google/docsy/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. +See also the list of [contributors](https://github.com/google/docsy/graphs/contributors) who participated in this project. + +## License ![GitHub](https://img.shields.io/github/license/google/docsy) + +This project is licensed under the Apache License 2.0 - see the [LICENSE.md](https://github.com/google/docsy/blob/master/LICENSE) file for details From af652817967930c585e63c6e96724b86fe0d7332 Mon Sep 17 00:00:00 2001 From: atharwa_24 Date: Sat, 1 Aug 2020 00:50:17 +0530 Subject: [PATCH 2/3] add contributors badge count --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ee2a6c247..75606eccba 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ hugo server --themesDir ../.. Note that you need the `themesDir` flag when running Hugo because the site files are inside the theme repo. -## Contributing +## Contributing ![GitHub](https://img.shields.io/github/contributors/google/docsy) Please read [CONTRIBUTING.md](https://github.com/google/docsy/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. See also the list of [contributors](https://github.com/google/docsy/graphs/contributors) who participated in this project. From 9be4f3f1847957efd19d66b177ca909720fcb2a7 Mon Sep 17 00:00:00 2001 From: atharwa_24 Date: Sat, 1 Aug 2020 01:00:56 +0530 Subject: [PATCH 3/3] fixed some typos --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 75606eccba..48b72d0e45 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Docsy +# Docsy Docsy is a [Hugo](https://gohugo.io/) theme for technical documentation sets, providing simple navigation, site structure, and more. @@ -22,12 +22,12 @@ The following are basic prerequisites for using Docsy in your site: ## Example and usage -You can find an example project that uses Docsy in the [Docsy Example Project repo](https://github.com/google/docsy-example). The Docsy Example Project is hosted at [https://example.docsy.dev/](https://example.docsy.dev/). +You can find an example project that uses Docsy in the [Docsy Example Project repo](https://github.com/google/docsy-example).The Docsy Example Project is hosted at [https://example.docsy.dev/](https://example.docsy.dev/). To use the Docsy theme for your own site: - (Recommended) Copy the [example project](https://github.com/google/docsy-example), - which includes the Docsy theme as a submodule. + which includes the Docsy theme as a submodule. You can customize this pre-configured basic site into your own Docsy themed site. [Learn more...](https://github.com/google/docsy-example) @@ -47,7 +47,7 @@ cd docsy/userguide/ hugo server --themesDir ../.. ``` -Note that you need the `themesDir` flag when running Hugo because the site files are inside the theme repo. +Note: you need the `themesDir` flag when running Hugo because the site files are inside the theme repo. ## Contributing ![GitHub](https://img.shields.io/github/contributors/google/docsy)