Skip to content
This repository was archived by the owner on Dec 10, 2024. It is now read-only.

Commit 784da9d

Browse files
committed
readme update
1 parent 55e0288 commit 784da9d

File tree

1 file changed

+67
-1
lines changed

1 file changed

+67
-1
lines changed

README.md

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,72 @@
11
# Haskell Foundation website
22

3-
## Based on the IOHK Gatsby Starter
3+
### Installation
4+
5+
Download and install Gatsby locally. Go using command line to the folder root and type:
6+
7+
```
8+
npm i
9+
```
10+
11+
12+
### Run the website on localhost
13+
14+
```
15+
npm start
16+
```
17+
18+
### Build the website into the /build/ folder
19+
20+
Creates HTML export from the Gatsbsy engine.
21+
22+
```
23+
npm run build
24+
```
25+
26+
27+
### Adding custom pages
28+
```
29+
npm run create-pages -- /custom-page/
30+
```
31+
32+
33+
### Removing custom pages
34+
```
35+
npm run delete-pages -- /custom-page/
36+
```
37+
38+
39+
### Editing top navigation
40+
41+
Open file `resources/content/global/global-en.md` and add or delete items from `global_navigation:`. `global_navigation_item_title:` is for the link text. `global_navigation_item_link:` is for the page path. Be sure to have it identical to the page name you created before.
42+
43+
Example:
44+
45+
```
46+
- global_navigation_item_title: Custom page
47+
global_navigation_item_link: /custom-page/
48+
49+
```
50+
51+
52+
### Adding files to link (images, documents)
53+
54+
Add your files to `/static/images/`. Your files can be then linked on path `/images/...`.
55+
56+
Example: Adding file with filename niceimage.jpg to `/static/images/` will have its path on `/images/niceimage.jpg`. Which is what you use for the link. In HTML:
57+
58+
```
59+
<img src='/images/niceimage.jpg' alt='Nice image' />
60+
```
61+
62+
In markdown:
63+
64+
```
65+
![Nice image](/images/niceimage.jpg)
66+
```
67+
68+
69+
## More about IOHK Gatsby Starter
470

571
If you use VisualStudio Code then it's recommended that you download the [code tour](https://github.com/vsls-contrib/code-tour) extension to make use of the guided tours of the codebase. Otherwise the documentation below should be sufficient. The tours will be setup on `npm install`.
672

0 commit comments

Comments
 (0)