Skip to content

Commit

Permalink
Merge branch 'demo' of github.com:dominrios/eclipse-volttron-fork int…
Browse files Browse the repository at this point in the history
…o demo
  • Loading branch information
dominrios committed Sep 16, 2024
2 parents 113f762 + f0b1378 commit 76fb3ae
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 6 deletions.
Empty file added .nojekyll
Empty file.
43 changes: 40 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,42 @@
# eclipse-volttron.github.io
## getting started
Prerequisites:
install windows terminal (I use ubuntu)
install Git, command: $sudo apt install git-all

## NOTE
installing hugo:
install hugo, command: $sudo apt install hugo
link for more info https://gohugo.io/installation/linux/#snap

BulidingsOperationsRight, ConnectedHomeRight, and MarketSInRight html files need to remove `/eclipse-volttron-fork/` from their anchor tags
using hugo:
enter the folder with the website
run the command $hugo serve
a link should appear to open the local web link

## making changes
Sidebar edits:
- Sidebars are found under the /layouts/partials/sidebars/ and are written in html
- markdown files have a sidebar_left and sidebar_right options where the sidebars are rendered
Markdown additions and edits:
- all markdown files are found under /content/
- to add a new markdown file to the main bar, add this to the top
"---
menu: main
title: "New Name"
description: "add a description for the gray text above the image"
image: "image path"
---"
Adding to submenu:
1. to add a new markdown file to the archives, add the markdown file to /content/archives/
2. set the menu to archives (menu:archives)
3. go to /config/_default/menus.toml/ and add
"[[main]]
parent = "ARCHIVES"
name = "NEW FILE NAME"
url = "/archives/NEW FILE NAME/"
weight = above name weight + 1"
Adding new image:
- add image to /static/images/
- use images/image_name.png as the path in markdown
*Note: images being added in html '{{absURL "images/DocumentImages/overviewOverlay.png"}}' or it will not render in github pages*
CSS Edits:
- do NOT use the CSS in the theme, go to /assets/sass/custom.scss to make changes.
2 changes: 1 addition & 1 deletion layouts/partials/sidebar/BuildingsOperationsRight.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ <h3>Accomplishments</h3>
<footer>
<a href="#" class="button">{{ T "sidebar_button_1" }}</a>
</footer>
</section>
</section>
2 changes: 1 addition & 1 deletion layouts/partials/sidebar/ConnectedHomeRight.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ <h3>Accomplishments</h3>
<footer>
<a href="#" class="button">{{ T "sidebar_button_1" }}</a>
</footer>
</section>
</section>
2 changes: 1 addition & 1 deletion layouts/partials/sidebar/MarketSlnRight.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ <h3>Accomplishments</h3>
<footer>
<a href="#" class="button">{{ T "sidebar_button_1" }}</a>
</footer>
</section>
</section>

0 comments on commit 76fb3ae

Please sign in to comment.