Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clustercockpit/cc-doc
ClusterCockpit documentation website
https://github.com/clustercockpit/cc-doc
docsy hugo website
Last synced: about 1 month ago
JSON representation
ClusterCockpit documentation website
- Host: GitHub
- URL: https://github.com/clustercockpit/cc-doc
- Owner: ClusterCockpit
- License: apache-2.0
- Created: 2024-01-16T19:32:31.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-04-13T06:01:09.000Z (9 months ago)
- Last Synced: 2024-04-13T20:50:23.164Z (9 months ago)
- Topics: docsy, hugo, website
- Language: HTML
- Homepage: https://clustercockpit.org
- Size: 5.21 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
This is the source code for ClusterCockpit documentation website.
It is based on [Docsy][], which is a [Hugo theme module][] for technical documentation sites, providing easy
site navigation, structure, and more.
For Docsy documentation, see [Docsy user guide][].
## How to contribute
A simple way to get started is to clone the repository:
```bash
git clone https://github.com/ClusterCockpit/cc-doc.git
```
If you want to do SCSS edits and want to publish these, you need to install `PostCSS`
```bash
npm install
```
## Running the website locally
Building and running the site locally requires a recent `extended` version of [Hugo](https://gohugo.io).
You can find out more about how to install Hugo for your environment in our
[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation) guide.
Once you've made your working copy of the site repo, from the repo root folder, run:
```bash
hugo server
```
## Troubleshooting
As you run the website locally, you may run into the following error:
```console
$ hugo server
WARN 2023/06/27 16:59:06 Module "project" is not compatible with this Hugo version; run "hugo mod graph" for more information.
Start building sites …
hugo v0.101.0-466fa43c16709b4483689930a4f9ac8add5c9f66+extended windows/amd64 BuildDate=2022-06-16T07:09:16Z VendorInfo=gohugoio
Error: Error building site: "C:\Users\foo\path\to\docsy-example\content\en\_index.md:5:1": failed to extract shortcode: template for shortcode "blocks/cover" not found
Built in 27 ms
```
This error occurs if you are running an outdated version of Hugo. As of docsy theme version `v0.7.0`, hugo version `0.110.0` or higher is required.
See this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo) of the user guide for instructions on how to install Hugo.
Or you may be confronted with the following error:
```console
$ hugo server
INFO 2021/01/21 21:07:55 Using config file:
Building sites … INFO 2021/01/21 21:07:55 syncing static files to /
Built in 288 ms
Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68" not found in file cache
```
This error occurs if you have not installed the extended version of Hugo.
See this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo) of the user guide for instructions on how to install Hugo.
Or you may encounter the following error:
```console
$ hugo server
Error: failed to download modules: binary with name "go" not found
```
This error occurs if you have not installed the `go` programming language on your system.
See this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-go-language) of the user guide for instructions on how to install `go`.
[deploys]: https://app.netlify.com/sites/docsy-example/deploys
[Docsy user guide]: https://docsy.dev/docs
[Docsy]: https://github.com/google/docsy
[Hugo theme module]: https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme
[Docker Compose documentation]: https://docs.docker.com/compose/gettingstarted/