https://github.com/govau/observatory-website
Landing page for gov.au Observatory
https://github.com/govau/observatory-website
analytics observatory
Last synced: 5 months ago
JSON representation
Landing page for gov.au Observatory
- Host: GitHub
- URL: https://github.com/govau/observatory-website
- Owner: govau
- License: mit
- Created: 2020-05-21T04:55:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T22:07:57.000Z (over 2 years ago)
- Last Synced: 2024-04-14T07:47:07.858Z (about 1 year ago)
- Topics: analytics, observatory
- Language: TypeScript
- Homepage: https://observatory.service.gov.au/
- Size: 11.6 MB
- Stars: 2
- Watchers: 4
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Start front end
Run the following commands:
```
$ npm i
$ npm run watch
```
### Edit content
All content can be found in the `/content` folder. It is contained in markdown files. View the [markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) for more information.
### Creating new pages
New pages can be with markdown files. For example to create a contact page, follow these steps:
1. In the `content` folder, create a new folder called `contact-us`.
2. In the `content/contact-us` folder, create a new file named `contact.md`
3. Add the following content to the page
```
---
path: /contact
title: Contact Us
type: standard
---
# Contact the team
To get into contact with the team, please email at [email protected]
```
The `path` attribute is the URL and the `title` attribute is for the [title](https://www.w3schools.com/tags/tag_title.asp) of the page.
### Create new blog
In the blogs folder create a new markdown file as before.
Blogs require frontmatter to sit at the top of the page. Below is an example.
Make sure the path text is comparable to the blog title for the purposes of
consistency and accessibility.
```
---
path: /blogs/start-smaller-to-build-better
title: Start smaller to build better
type: blog
description: In the world of agile product development, the metaphor that it is smarter to build a skateboard than it is to build a car is well-known.
date: "2020-05-12"
author: Observatory teams
imgUrl: ../../skateboard-socials.png
---
This is the blog text
```
### Create a new event
This process is very similar to creating a new blog.
Firstly create a new markdown file in the `content/events` folder.
Then add frontmatter to the top of this newly created file. Something like
below. Make sure the path text is comparable to the event title for the purposes
of consistency and accessibility.
```
---
path: /events/drop-in-clinic
title: August drop in clinic
type: event
description: Join us for the drop in clinic
date: "2020-05-10"
imgUrl: ../../observatory-blog-hero.png
---
This is the event text
```
#### Add page to main navigation/footer navivation
To add links to new pages in the main nav bar or the footer, follow these steps:
1. Open up the `gatsby-config.js` file.
2. Find the `menuLinks` key for main nav links and the `footerLinks` key for the footer items.
3. If you want to add a main nav link to the contact page we created above, add an object to the `menuLinks` key.
#### Before
```
menuLinks: [
{
text: "Home",
link: "/",
},
{
text: "About",
link: "/about",
},
]
```
#### After
```
menuLinks: [
{
text: "Home",
link: "/",
},
{
text: "About",
link: "/about",
},
{
text: "Contact",
link: "/contact",
},
],
```
The footer links can be updated in a similar way using the `footerLinks` key in the `gatsby-config.js` file.