Skip to content

Commit

Permalink
edited website guide
Browse files Browse the repository at this point in the history
  • Loading branch information
lorhzy09 committed Aug 30, 2023
1 parent 9eaf112 commit 44318d7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 11 deletions.
3 changes: 2 additions & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,15 @@ GEM
safe_yaml (1.0.5)
sass-embedded (1.66.1-arm64-darwin)
google-protobuf (~> 3.23)
sass-embedded (1.66.1-x86_64-linux-gnu)
sass-embedded (1.66.1-x86_64-linux)
google-protobuf (~> 3.23)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.4.2)
webrick (1.8.1)

PLATFORMS
arm64-darwin-21
arm64-darwin-22
x86_64-linux

Expand Down
12 changes: 2 additions & 10 deletions docs/website-guide/website-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,17 @@ Before learning to edit and update the website, it's better to have a basic unde

- `_config.yml`
is a YAML file that stores configuration data, which include site settings and rarely changed variables (name, description, etc.)

> note: folders that starts with a "_" are special folders associatedwith the jekyll template. Every other directory/file such as `css` files and `images` folder are generate verbatim to site.

- `_data`:
contains well-formatted site data. Jekyll automatically loads its children files (in `.yml`, `.yaml`, `.json`, `.csv` or `.tsv`) to be accessible via `site.data`.

To access contents of a file: for a file named `members.yml`, use code `site.data.members`.

- **`_data`**:
contains well-formatted site data. Jekyll automatically loads its children files (in `.yml`, `.yaml`, `.json`, `.csv` or `.tsv`) to be accessible via `site.data`. (To access contents of a file: for a file named `members.yml`, use code `site.data.members`)
- `navigation.yml` navigation for the pages

- `sitetext.yml`

- `style.yml`

- `_includes`:
partial html pages mixed and matched by layouts and posts to facilitate reuse.


- `_layouts`:
html templates that wrap posts, chosen on a post-by-post basis in the front matter.

Expand Down

0 comments on commit 44318d7

Please sign in to comment.