Skip to content

Commit

Permalink
Merge pull request #5 from sora-ryu/docs
Browse files Browse the repository at this point in the history
Improvement on Documentation
  • Loading branch information
deslaughter authored Sep 24, 2024
2 parents 20e5675 + 07bc85e commit 5a32d8a
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 3 deletions.
46 changes: 46 additions & 0 deletions docs/content/docs/contribute/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: 'Contribute'
date: 2024-08-22T16:35:17-06:00
draft: false
weight: 11
---

This page is for describing how to add, improve, and update ACDC documentation.

### Installation
The documentation is generated using the [Hugo](https://gohugo.io) documentation generator. We recommend running below commands for each machine.

#### macOS/Linux

```bash
$ brew install hugo
```

#### Windows

```bash
$ choco install hugo-extended
```

Note that Hugo with Extended edition is required for building the documentation with [current theme](https://themes.gohugo.io/themes/hugo-whisper-theme/). Make sure you see **/extended** after the version number, once you run `hugo version`.


### Getting started

#### Add new page
To add a new page, `cd docs` and run:

```bash
$ hugo new content content/docs/[new_page_name]/index.md
```

Open the file with your editor and add contents.

#### View site
To test your site, run:

```bash
$ hugo server
```

Now enter `localhost:1313` in the address bar of your browser. The server rebuilds your site and refreshes your browser whenever it detects the change.
2 changes: 2 additions & 0 deletions docs/content/docs/evaluate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ The `Evaluate` tab runs a case to generate linearization files at each operating

The first step in performing an evaluation is to select the OpenFAST executable by clicking the `Browse` button as shown in the following figure. This action opens a dialog box to select the path to the executable. The dialog will default to the path of `openfast` in the system's path, if one is found.

To paste the OpenFAST executable path direclty from the finder on Mac, we recommend to use ⇧⌘G (Command+Shift+G).

![evaluate-openfast](evaluate-openfast.png)


Expand Down
4 changes: 2 additions & 2 deletions docs/themes/hugo-whisper-theme/layouts/_default/baseof.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">

{{ if .Site.IsServer }}
{{ if hugo.IsServer }}
{{ $style := resources.Get "scss/style.scss" | toCSS (dict "targetPath" "css/style.css" "enableSourceMap" true) }}
<link rel="stylesheet" href="{{ ($style).RelPermalink }}">
{{ else }}
Expand Down Expand Up @@ -67,7 +67,7 @@
{{ block "footer_js" . }}
{{ end }}

{{ if .Site.IsServer }}
{{ if hugo.IsServer }}
<script type="text/javascript" src="{{ $scripts.RelPermalink }}"></script>
{{ else }}
<script type="text/javascript" src="{{ ($scripts | minify | fingerprint).RelPermalink }}"></script>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{{- if .Site.IsServer -}}
{{- if hugo.IsServer -}}
<!-- Dont add Google analytics to localhost -->
{{ else }}
{{ $gid := (getenv "HUGO_GOOGLE_ANALYTICS_ID") }}
Expand Down

0 comments on commit 5a32d8a

Please sign in to comment.