<commit_before># Docsy

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

This is not an officially supported Google product. This project is currently maintained.


## Installation and prerequisites

You need a recent version of Hugo to build sites using this theme (preferably 0.45+). If you install from the [release page](https://github.com/gohugoio/hugo/releases), make sure to get the `extended` Hugo version which supports SCSS. Alternatively, on macOS you can install Hugo via Brew.

You'll also need `PostCSS` to create the final CSS assets when building your site. You can install it locally with:

```
npm install
````

To use a local version of the theme files, clone the repo using:

```
git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git
```


## Usage and documentation

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://goldydocs.netlify.com/](https://goldydocs.netlify.com/).

To use the Docsy theme, you can either:

* Copy and edit the example project’s repo, which will also give you a skeleton structure for your top-level and documentation sections, or
* Specify the Docsy theme like any other [Hugo theme](https://gohugo.io/themes/installing-and-using-themes/)
 when creating or updating your site. This gives you all the theme-y goodness but you’ll need to specify your own site structure.

Docsy also has its own user guide (using Docsy, of course!), which you can find at [https://docsydocs.netlify.com/](https://docsydocs.netlify.com/). Alternatively you can use Hugo to generate and serve a local copy (also useful for testing local theme changes), making sure you have installed all the prerequisites listed below:

```
git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git
cd docsy/userguide/
hugo server --themesDir ../..
```

Note that you need the `themesDir` flag because the site files are inside the theme repo.

You can find out much more about using Docsy in the [user guide](https://docsydocs.netlify.com/).
<commit_msg>Update prereqs and install in README<commit_after># Docsy

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

This is not an officially supported Google product. This project is actively being maintained.


## Prerequisites and installation overview

The following high-level list includes the basic prerequisites for using Docsy in your site. 

<!-- TODO: Update to docsy.dev URL -->
See the 
[Docsy Getting Started Guide](https://docsydocs.netlify.com/docs/getting-started/) for a complete list of the
prerequisites and details about the various installation options.

To use the Docsy theme in your site, you must meet the following prerequisites:

- Install a recent release of the Hugo "extended" version (we recommend version 0.53 or later). If you install from the 
  [release page](https://github.com/gohugoio/hugo/releases), you must ensure to download the `hugo_extended` version 
  which supports SCSS.

- Get the Docsy theme:

  - (Recommended) Start with the Docsy Example project and use Docsy as a submodule. If you clone the Docsy Example site, 
    you can modify and customize a pre-configured site, into your own Docsy themed site. 
    [Learn more...](https://github.com/google/docsy-example)
  
  - Add docsy to your exsiting site. You can either add Docsy as a submodule, or clone the Docsy repo into your site.
    See the complete list of [Docsy installation options](https://docsydocs.netlify.com/docs/getting-started/) .
  
    For example, to clone Docsy into the `theme` directory of your project, you run the following command from 
    your project's root directory:
    
    ```
    git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git themes/docsy
    ```

- 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:

  ```
  sudo npm install -D --save autoprefixer
  sudo npm install -D --save postcss-cli
  ```

## Usage and documentation


<!-- TODO: Update to docsy.dev URL -->
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://goldydocs.netlify.com/](https://goldydocs.netlify.com/).

To use the Docsy theme, you can either:

* Copy and edit the example project’s repo, which will also give you a skeleton structure for your top-level and documentation sections, or
* Specify the Docsy theme like any other [Hugo theme](https://gohugo.io/themes/installing-and-using-themes/)
 when creating or updating your site. This gives you all the theme-y goodness but you’ll need to specify your own site structure.


<!-- TODO: Update to docsy.dev URL -->
Docsy also has its own user guide (using Docsy, of course!), which you can find at [https://docsydocs.netlify.com/](https://docsydocs.netlify.com/). Alternatively you can use Hugo to generate and serve a local copy (also useful for testing local theme changes), making sure you have installed all the prerequisites listed below:

```
git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git
cd docsy/userguide/
hugo server --themesDir ../..
```

Note that you need the `themesDir` flag because the site files are inside the theme repo.

<!-- TODO: Update to docsy.dev URL -->
You can find out much more about using Docsy in the [user guide](https://docsydocs.netlify.com/).

{'fraction_non_alphanumeric': 0.08790252393385553, 'fraction_numerical': 0.0017406440382941688, 'mean_word_length': 3.9705882352941178, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 25, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2780162', 'n_tokens_mistral': 1663, 'n_tokens_neox': 1560, 'n_words': 746}