Skip to content

Commit eb4fcb0

Browse files
authored
README: markdown cleanup, line-wrapping, etc (#892)
1 parent 5958d94 commit eb4fcb0

File tree

1 file changed

+53
-31
lines changed

1 file changed

+53
-31
lines changed

README.md

+53-31
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,81 @@
1-
# Docsy
1+
# Docsy
22

3-
Docsy is a [Hugo](https://gohugo.io/) theme for technical documentation sets, providing simple navigation, site structure, and more.
3+
Docsy is a [Hugo](https://gohugo.io) theme for technical documentation sets,
4+
providing simple navigation, site structure, and more.
45

5-
This is not an officially supported Google product. This project is actively being maintained.
6+
This is not an officially supported Google product. This project is actively
7+
being maintained.
68

79
## Prerequisites
810

911
The following are basic prerequisites for using Docsy in your site:
1012

11-
- Install a recent release of the Hugo "extended" version (we recommend version 0.53 or later). If you install from the
12-
[release page](https://github.com/gohugoio/hugo/releases), make sure you download the `_extended` version
13-
which supports SCSS.
13+
- Install a recent release of the Hugo "extended" version (we recommend version
14+
0.53 or later). If you install from the [release
15+
page](https://github.com/gohugoio/hugo/releases), make sure you download the
16+
`_extended` version which supports SCSS.
1417

15-
- Install `PostCSS` so that the site build can create the final CSS assets. You can install it locally by running
16-
the following commands from the root directory of your project:
18+
- Install `PostCSS` so that the site build can create the final CSS assets. You
19+
can install it locally by running the following commands from the root
20+
directory of your project:
1721

18-
```
19-
sudo npm install -D --save autoprefixer
20-
sudo npm install -D --save postcss-cli
22+
```console
23+
$ sudo npm install -D --save autoprefixer
24+
$ sudo npm install -D --save postcss-cli
2125
```
2226

2327
## Example and usage
2428

25-
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/). For real-life examples of sites that use Docsy (and their source repos), see our [Examples](https://www.docsy.dev/docs/examples/) page.
29+
You can find an example project that uses Docsy in the [Docsy Example Project
30+
repo](https://github.com/google/docsy-example).The Docsy Example Project is
31+
hosted at [https://example.docsy.dev](https://example.docsy.dev). For
32+
real-life examples of sites that use Docsy (and their source repos), see our
33+
[Examples](https://www.docsy.dev/docs/examples/) page.
2634

2735
To use the Docsy theme for your own site:
2836

29-
- (Recommended) Use the [example project](https://github.com/google/docsy-example),
30-
which includes the Docsy theme as a submodule, as a template to create your project.
31-
You can customize this pre-configured basic site into your own Docsy themed site.
32-
[Learn more...](https://github.com/google/docsy-example)
33-
34-
- Add Docsy to your existing Hugo site repo's `themes` directory. You can either add Docsy as a Git submodule, or
35-
clone the Docsy theme into your project.
37+
- (Recommended) Use the [example
38+
project](https://github.com/google/docsy-example), which includes the Docsy
39+
theme as a submodule, as a template to create your project. You can customize
40+
this pre-configured basic site into your own Docsy themed site. [Learn
41+
more...](https://github.com/google/docsy-example)
3642

37-
See the [Docsy Getting Started Guide](https://docsy.dev/docs/getting-started/) for
38-
details about the various usage options.
43+
- Add Docsy to your existing Hugo site repo's `themes` directory. You can
44+
either add Docsy as a Git submodule, or clone the Docsy theme into your
45+
project.
3946

40-
## Documentation
47+
See the [Docsy Getting Started Guide](https://docsy.dev/docs/getting-started/)
48+
for details about the various usage options.
4149

42-
Docsy has its own user guide (using Docsy, of course!) with lots more information about using the theme, which you can find at [https://docsy.dev/](https://docsy.dev/). Alternatively you can use Hugo to generate and serve a local copy of the guide (also useful for testing local theme changes), making sure you have installed all the prerequisites listed above:
50+
## Documentation
4351

44-
```
45-
git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git
46-
cd docsy/userguide/
47-
hugo server --themesDir ../..
52+
Docsy has its own user guide (using Docsy, of course!) with lots more
53+
information about using the theme, which you can find at
54+
[https://docsy.dev](https://docsy.dev). Alternatively you can use Hugo to
55+
generate and serve a local copy of the guide (also useful for testing local
56+
theme changes), making sure you have installed all the prerequisites listed
57+
above:
58+
59+
```console
60+
$ git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git
61+
$ cd docsy/userguide/
62+
$ hugo server --themesDir ../..
4863
```
4964

50-
Note: you need the `themesDir` flag when running Hugo because the site files are inside the theme repo.
65+
Note: you need the `themesDir` flag when running Hugo because the site files are
66+
inside the theme repo.
5167

5268
## Contributing ![GitHub](https://img.shields.io/github/contributors/google/docsy)
5369

54-
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.
55-
See also the list of [contributors](https://github.com/google/docsy/graphs/contributors) who participated in this project.
70+
Please read
71+
[CONTRIBUTING.md](https://github.com/google/docsy/blob/master/CONTRIBUTING.md)
72+
for details on our code of conduct, and the process for submitting pull requests
73+
to us. See also the list of
74+
[contributors](https://github.com/google/docsy/graphs/contributors) who
75+
participated in this project.
5676

5777
## License ![GitHub](https://img.shields.io/github/license/google/docsy)
5878

59-
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
79+
This project is licensed under the Apache License 2.0 - see the
80+
[LICENSE.md](https://github.com/google/docsy/blob/master/LICENSE) file for
81+
details

0 commit comments

Comments
 (0)