Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/google/docsy.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoratharwa_24 <atharwa.kharkar19@vit.edu>2020-07-31 22:30:56 +0300
committerGitHub <noreply@github.com>2020-07-31 22:30:56 +0300
commit9be4f3f1847957efd19d66b177ca909720fcb2a7 (patch)
tree2aa39264677339d4b7250f3f95e8341db914877c /README.md
parentaf652817967930c585e63c6e96724b86fe0d7332 (diff)
fixed some typos
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 75606ec..48b72d0 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)