Skip to content

Commit 32e0a13

Browse files
committed
Update README with instructions for Astro
1 parent 149f8f6 commit 32e0a13

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# Team CYB3RL4NG's Website
22

3-
We use [Hugo](https://gohugo.io/) to generate the website. Use `hugo server` to try out locally.
3+
We use [Astro](https://astro.build/) to generate the website.
44

5-
Project structure:
5+
## Project structure
66

7-
- If you want to change the actual text content of the website, go to [`content`](/content)
8-
- Homepage: [`content/_index.md`](/content/_index.md)
9-
- About page: [`content/about.md`](/content/about.md)
10-
- Timeline: [`content/timeline.md`](/content/timeline.md)
11-
- Blogs: [`content/blog`](/content/blog/)
12-
- Styling ([Sass](https://sass-lang.com/)) is in [`assets/sass`](/assets/sass)
13-
- HTML templates are in [`layouts`](/layouts/)
14-
- [`data/settings.yaml`](/data/settings.yaml) has settings for
15-
- Page links in navbar
16-
- Social media links/icons in navbar
17-
- Contact info
18-
- Images go in [`static/img`](/static/img/)
7+
- If you want to work on blog posts, go to [`src/content/blog`](/src/content/blog/)
8+
- If you want to change the other text content of the website, go to [`src/pages`](/src/pages)
9+
- Homepage: [`index.mdx`](/src/pages/index.mdx)
10+
- Blog index page: [`src/pages/blog/index.astro`](/src/pages/blog/index.astro)
11+
- Individual blog pages: [`src/pages/blog/[...slug].astro`](/src/pages/blog/[...slug].astro)
12+
- Layouts are in [`src/layouts`](/src/layouts/)
13+
- `public` contains assets that visitors will get directly
14+
- Favicon goes in [`public/favicon.ico`](/public/favicon.ico)
15+
- Images go in [`public/img`](/public/img/)
16+
- Fonts go in [`public//fonts`](/public/fonts/)
17+
18+
## Project setup
19+
20+
I think you'll need to install Node.js and run `npm i` in this directory.
21+
22+
Use `npm run dev` to build and run the website locally.

0 commit comments

Comments
 (0)