Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: warn that main is potentially unstable + some copyedits #1601

Merged
merged 3 commits into from
Jul 4, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 41 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Docsy

## 🚧 WARNING 🚧 : `main` is under development and potentially unstable! Use official Docsy [releases].

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

Expand All @@ -12,52 +14,54 @@ The following are basic prerequisites for using Docsy in your site:

- Install a recent release of the Hugo "extended" version. If you install from
the [Hugo release page](https://github.com/gohugoio/hugo/releases), make sure
you download the `_extended` version which supports SCSS.
you download the `extended` version, which supports SCSS.

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

```console
$ npm install --save-dev autoprefixer
$ npm install --save-dev postcss-cli
```sh
npm install --save-dev autoprefixer
npm install --save-dev postcss-cli
```

Starting in [version 8 of `postcss-cli`](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md),

Starting in
[version 8 of `postcss-cli`](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md),
you must also separately install `postcss`:

```bash
```sh
npm install -D postcss
```

Any additional prerequisites depend on the [installation option](https://www.docsy.dev/docs/get-started/#installation-options)
you choose. We recommend using Docsy as a Hugo module, which requires that
you have the `go` language installed in addition to Hugo and PostCSS.

For complete prerequisites and instructions, see our [Get started guides](https://www.docsy.dev/docs/get-started/).
Any additional prerequisites depend on the
[installation option](https://www.docsy.dev/docs/get-started/#installation-options)
you choose. We recommend using Docsy as a Hugo module, which requires that you
have the `go` language installed in addition to Hugo and PostCSS.

For complete prerequisites and instructions, see our
[Get started guides](https://www.docsy.dev/docs/get-started/).

## 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 [example.docsy.dev](https://example.docsy.dev). For
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 [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.

To use the Docsy theme for your own site:

- (Recommended) Use the [example
project](https://github.com/google/docsy-example), which includes the Docsy
theme as a Hugo module, as a template to create your project. You can customize
this pre-configured basic site into your own Docsy themed site. [Learn
more...](https://github.com/google/docsy-example)
- (Recommended) Use the
[example project](https://github.com/google/docsy-example), which includes the
Docsy theme as a Hugo module, as a template to create your project. You can
customize this pre-configured basic site into your own Docsy themed site.
[Learn more...](https://github.com/google/docsy-example)

- Add Docsy to your existing Hugo site. You can
add Docsy as a Hugo module, as a Git submodule, or clone the Docsy theme into your
project.
- Add Docsy to your existing Hugo site. You can add Docsy as a Hugo module, as a
Git submodule, or clone the Docsy theme into your project.

See the [Get started guides](https://www.docsy.dev/docs/get-started/)
for details about the various usage options.
See the [Get started guides](https://www.docsy.dev/docs/get-started/) for
details about the various usage options.

## Documentation

Expand All @@ -70,27 +74,27 @@ 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:

```console
$ git clone --depth 1 https://github.com/google/docsy.git
$ cd docsy/userguide/
$ npm install
$ npm run serve
```sh
git clone --depth 1 https://github.com/google/docsy.git
cd docsy/userguide/
npm install
npm run serve
```

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

Please read
[CONTRIBUTING.md](https://github.com/google/docsy/blob/main/CONTRIBUTING.md)
for details on our code of conduct, and the process for submitting pull requests
to us. See also the list of
[CONTRIBUTING.md](https://github.com/google/docsy/blob/main/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/main/LICENSE) file for
details
[LICENSE.md](https://github.com/google/docsy/blob/main/LICENSE) file for details

[Deploys]: https://app.netlify.com/sites/docsydocs/deploys
[Netlify]: https://netlify.com
[deploys]: https://app.netlify.com/sites/docsydocs/deploys
[netlify]: https://netlify.com
[releases]: https://github.com/google/docsy/releases