Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/releaseworks/the-devops-docs
A learning resource on how to do DevOps the Releaseworks way
https://github.com/releaseworks/the-devops-docs
Last synced: about 2 months ago
JSON representation
A learning resource on how to do DevOps the Releaseworks way
- Host: GitHub
- URL: https://github.com/releaseworks/the-devops-docs
- Owner: releaseworks
- License: apache-2.0
- Created: 2020-01-09T12:38:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-17T13:09:26.000Z (about 1 year ago)
- Last Synced: 2023-11-18T14:35:03.181Z (about 1 year ago)
- Language: HTML
- Size: 2.55 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Docsy Example
[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://example.docsy.dev/](https://example.docsy.dev/).
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/google/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
```