Skip to content

Commit bb8a5f1

Browse files
authored
Merge pull request #36 from solidify-project/feature/help
quickstart guide added
2 parents 328b72c + af0d9dd commit bb8a5f1

2 files changed

Lines changed: 90 additions & 1 deletion

File tree

_help/src/Pages/home.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ title: Solidify Project Help
55

66
---
77

8-
## Table of contents
8+
### Quickstart guide
9+
10+
- [Create my first website](/quickstart/create-my-first-website.html)
11+
12+
### Reference
913

1014
- [Folders structure](/folders-structure.html)
1115

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
url: quickstart/create-my-first-website.html
2+
template: default.hjs
3+
4+
title: Create my first website
5+
6+
---
7+
8+
[back to help root](/index.html)
9+
10+
This guide describes how to create your first static website with Solidify Project engine.
11+
12+
### Preparation
13+
14+
Before we start you should create a new empty folder for your website. Let's name that folder `MySite`.
15+
16+
### Get the engine
17+
18+
Solidify Project engine is usualy distributed as a `.zip` archived folder. You should unzip its content to `MySite` folder, so you will have the following stuff on your file system:
19+
20+
```none
21+
MySite
22+
engine
23+
....
24+
config.yaml
25+
```
26+
27+
In addition to that you will also have either `solidify.sh` or `solidify.bat` inside `MySite` folder (the exact file depends on what operational system you are using). This script file in nothing more than a script wrapper that provides you with easy access to engine executables.
28+
29+
### Bootstrap some website
30+
31+
To bootstrap your first website execute a command from `MySite` folder.
32+
33+
##### Windows
34+
```bash
35+
solidify.bat bootstrap
36+
```
37+
38+
##### MacOS or Linux
39+
```bash
40+
./solidify.sh bootstrap
41+
```
42+
43+
After that you will see a new folder `src` under `MySite` folder. It will look like this:
44+
45+
```none
46+
MySite
47+
engine
48+
....
49+
src
50+
....
51+
config.yaml
52+
```
53+
54+
### Make some changes
55+
56+
To change default website content, please refer to [Folders structure](/folders-structure.html) section. It will describe what is inside `src` folder and how it affects the final website.
57+
58+
### Render your website
59+
60+
After making changes you can render your website by executing the following command from `MySite` folder.
61+
62+
##### Windows
63+
```bash
64+
solidify.bat render
65+
```
66+
67+
##### MacOS or Linux
68+
```bash
69+
./solidify.sh render
70+
```
71+
72+
After that you will see a new folder `www` under `MySite` folder. It will look like this:
73+
74+
```none
75+
MySite
76+
engine
77+
....
78+
src
79+
....
80+
www
81+
....
82+
config.yaml
83+
```
84+
85+
You can find pre-rendered minified version of your website inside `www` folder.

0 commit comments

Comments
 (0)