@paroicms/server 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,6 +13,24 @@ npm i
|
|
|
13
13
|
npm run dev
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
+
Then, connect to your back-office: http://localhost:8080/adm . Use `dev@localhost` for the login and `init` for the password.
|
|
17
|
+
|
|
18
|
+
Here are some tips:
|
|
19
|
+
|
|
20
|
+
- In the back-office, starts with _Configuration → Site properties_;
|
|
21
|
+
- Read the `config.json` file: it is a configuration for a local environment;
|
|
22
|
+
- Read the `site-schema.json` file: it is the schema of your website;
|
|
23
|
+
- The file `theme/theme.json` contains the list of available sizes (in pixels) in the text editors;
|
|
24
|
+
- You'll find the SCSS in `theme/assets/scss/index.scss`, it is compiled by the watcher in `theme/assets/scss/index.css`;
|
|
25
|
+
- If you edit your theme with Visual Studio Code, then we suggest that you install the _Liquid_ extension, from _panoply (liquify.dev)_;
|
|
26
|
+
- Then the templates of your website are in `theme/templates/`;
|
|
27
|
+
- In a Liquid file (for example `theme/templates/home.liquid`), use our `info` filter to inspect the content of a payload:
|
|
28
|
+
|
|
29
|
+
```liquid
|
|
30
|
+
{{ site | info }}
|
|
31
|
+
{{ page | info }}
|
|
32
|
+
```
|
|
33
|
+
|
|
16
34
|
## Documentation
|
|
17
35
|
|
|
18
36
|
Here is a draft of the [documention for `site-schema.json` files](https://gitlab.com/paroi/opensource/paroicms/-/blob/main/documentation/json-of-site-schema/interfaces/JsonOfSiteSchema.md).
|