basic layout

_quarto.yml

@@ -0,0 +1,43 @@
+project:
+  type: website
+
+website:
+  title: "CEEM Gists"
+  favicon: assets/ceem_logo.png
+  search: true
+  repo-url: https://github.com/UNSW-CEEM/CEEM-Gists
+  repo-actions: [edit, issue]
+  navbar:
+    title: CEEM Gists
+    logo: assets/ceem_logo.png
+    left:
+      - text: Home
+        href: index.qmd
+      - text: "Snippets"
+        menu:
+        - aemo_data.qmd 
+      - text: Contributing
+        href: contributing.qmd
+    right:
+    - icon: house
+      href: https://www.ceem.unsw.edu.au/
+    - icon: linkedin
+      href: https://github.com/UNSW-CEEM
+    - icon: twitter
+      href: https://twitter.com/CEEM_UNSW
+    - icon: github
+      menu:
+        - text: Source Code
+          url:  https://github.com/UNSW-CEEM/CEEM-Gists
+        - text: UNSW CEEM GitHub Organisation Page
+          url:  https://bugs.com
+
+  page-footer: "All source code made available on this site is licensed under GPL-3.0-or-later"
+format:
+  html:
+    theme: cosmo
+    css: styles.css
+    toc: true
+
+
+

aemo_data.qmd

@@ -0,0 +1,3 @@
+---
+title: AEMO Data Snippets
+---

assets/styles.css

@@ -0,0 +1 @@
+/* css styles */

contributing.qmd

@@ -0,0 +1,38 @@
+---
+title: Contributing
+---
+
+Please only share code snippets or scripts that you are happy to be available publicly.
+
+## Preparing your script/code
+
+1. Though the website and repository contains license conditions, we suggest you include this snippet as a preface to any source code:
+
+    ```text
+    <one line to give the program's name and a brief idea of what it does.>
+        Copyright (C) <year>  <name of author>
+
+        This program is free software: you can redistribute it and/or modify
+        it under the terms of the GNU General Public License as published by
+        the Free Software Foundation, either version 3 of the License, or
+        (at your option) any later version.
+
+        This program is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+        GNU General Public License for more details.
+
+        You should have received a copy of the GNU General Public License
+        along with this program.  If not, see <https://www.gnu.org/licenses/>.
+    ```
+
+2. [Optional] Format your code using [black](https://github.com/psf/black) and [isort](https://github.com/pycqa/isort/). This step is optional because these will be automatically run on any pull requests.
+
+3. Fork [this repo](https://github.com/UNSW-CEEM/CEEM-Gists) or clone and create a new branch
+
+4. Add your source code to the folder that best matches what it does or pertains to.
+    - If you need to create a new folder/page:
+      - Create the folder in [`snippets`](https://github.com/UNSW-CEEM/CEEM-Gists/snippets)
+      - Create a corresponding `.qmd` file in the root of the repository
+      - In the [Quarto YAML config](https://github.com/UNSW-CEEM/CEEM-Gists/_quarto.yml), add the `.qmd` under the snippets menu
+

index.qmd

@@ -0,0 +1,16 @@
+---
+title: "CEEM-Gists"
+---
+
+This site hosts code snippets shared by members of the [UNSW Collaboration on Energy and Environmental Markets (CEEM)](https://www.ceem.unsw.edu.au/).
+
+## Using these snippets
+
+All source code available on this website and its corresponding repository are licensed under the terms of GPL-3.0-or-later.
+
+For the license details, please see the repository [licese](https://github.com/UNSW-CEEM/CEEM-Gists/blob/main/LICENSE).
+
+## About this site
+
+This is a [Quarto](https://quarto.org/docs/websites) website.
+