Skip to content

Improve README #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Zethson merged 1 commit into from
May 6, 2026
+6 −3
Merged

Improve README #209

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
# scverse.org

This is a website for [scverse.org](https://scverse.org). This version uses [Hugo](https://gohugo.io/) to build it.
This is a website for [scverse.org](https://scverse.org) based on [Hugo](https://gohugo.io/).

## Repository structure

### Content

Most of the times, only the content has to be modified. Content is stored as [TOML](https://toml.io/en/) in `.md` files in [`/content`](/content). E.g. to modify the contents of the tutorials page, one has to look inside [`/content/learn/_index.md`](/content/learn/_index.md).
Most of the times, only the content has to be modified.
Content is stored as [TOML](https://toml.io/en/) in `.md` files in [`/content`](/content).
To modify the contents of the tutorials page, for example, one has to look inside [`/content/learn/_index.md`](/content/learn/_index.md).

### Styles

For style sheets, [SCSS](https://sass-lang.com/) is used. Modify [`/assets/main.scss`](/assets/main.scss) to change styles.

### Layout

Modifying layout is only required when pages have to be restuctured or new pages are to be added. Look inside [`/layout`](/layout) for that. [Hugo Templating](https://gohugo.io/templates/introduction/) is used to work with content from [`/content`](/content).
Modifying layout is only required when pages have to be restuctured or new pages are to be added.
Look inside [`/layout`](/layout) for that. [Hugo Templating](https://gohugo.io/templates/introduction/) is used to work with content from [`/content`](/content).

## Running locally

Expand Down
Loading