https://github.com/ly0n/docsy-action

https://github.com/ly0n/docsy-action

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/ly0n/docsy-action
• Owner: Ly0n
• License: apache-2.0
• Created: 2020-07-05T11:11:17.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T12:14:55.000Z (about 2 years ago)
• Last Synced: 2024-06-11T16:31:06.087Z (7 months ago)
• Language: HTML
• Size: 5.09 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Docsy Example using The Documentation System

This repo is a fork of the [Docsy Example Project](https://github.com/google/docsy-example), but restructured using [The Documentation System](https://documentation.divio.com/) by Daniele Procida.        

[Docsy](https://github.com/google/docsy) is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more. This **Docsy Example Project** uses the Docsy theme, as well as providing a skeleton documentation structure for you to use. You can either copy this project and edit it with your own content, or use the theme in your projects like any other [Hugo theme](https://gohugo.io/themes/installing-and-using-themes/).

This Docsy Example Project is hosted at (https://capsulecorplab.github.io/docsy-example/).

You can find detailed theme instructions in the Docsy user guide: https://docsy.dev/docs/

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

## Cloning the Docsy Example Project

The following will give you a project that is set up and ready to use (don't forget to use `--recurse-submodules` or you won't pull down some of the code you need to generate a working site). The `hugo server` command builds and serves the site. If you just want to build the site, run `hugo` instead.

```bash

git clone --recurse-submodules --depth 1 https://github.com/capsulecorplab/docsy-example.git

cd docsy-example

hugo server

```

The theme is included as a Git submodule:

```bash

▶ git submodule

 a053131a4ebf6a59e4e8834a42368e248d98c01d themes/docsy (heads/master)

```

If you want to do SCSS edits and want to publish these, you need to install `PostCSS` (not needed for `hugo server`):

```bash

npm install

```

## Running the website locally

Once you've cloned the site repo, from the repo root folder, run:

```

hugo server

```