Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ojack committed Nov 21, 2023
1 parent 96c9f72 commit a4743e8
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
13 changes: 9 additions & 4 deletions README.md
Expand Up @@ -4,16 +4,21 @@ source code for documentation running at https://hydra-synth.github.io/hydra-doc

### To run locally:

1. install hugo:
1. install hugo: https://gohugo.io/installation/
2. clone this repo:
```git clone https://github.com/hydra-synth/hydra-docs-v2.git```
3. clone submodules:
```git submodule update --init --recursive```
4. run locally:
```hugo serve```
5. (optional) set baseURL in `config.toml` or using `--baseURL` to your hosting URL (e.g., `https://myhydrawebsite.com/blog`)
6. (optional) build:
```hugo```

### To edit:
1. Create a branch of this repo
2. Update markdown files contained in the `/content/docs`` folder
3. Commit your changes
4. Submit a pull request



### Content that is not yet included
- Information about alternative editors such as flok, atom/pulsar.
Expand Down
2 changes: 1 addition & 1 deletion content/_index.md
Expand Up @@ -3,7 +3,7 @@ title: "hydra video synth: documentation portal"
draft: false
weight: 1
images: [ images/hydra.png ]
description: "how to use hydra"
description: "tutorials and reference for using hydra"
---

# What is Hydra?
Expand Down
3 changes: 1 addition & 2 deletions content/docs/reference.md
Expand Up @@ -2,8 +2,7 @@
weight: 3
bookFlatSection: true
title: "reference"
bookCollapseSection: true

# bookCollapseSection: true
---

<iframe src="https://hydra.ojack.xyz/api" frameBorder="0" width="965" frame="false" height="700"></iframe>

0 comments on commit a4743e8

Please sign in to comment.