Skip to content
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

fix(docs): readme #29

Merged
merged 3 commits into from
Apr 11, 2024
Merged

fix(docs): readme #29

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7082fa
markdownlint
Apr 11, 2024
ed3798b
npm ci > npm install
Apr 11, 2024
752755f
typo
Apr 11, 2024
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
25 changes: 16 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
# funkin.me source code

This is the source code repository for the FUNKIN CREW WEBSITE, [`funkin.me`](https://funkin.me)
This is the source code repository for the FUNKIN CREW WEBSITE,
[`funkin.me`](https://funkin.me)

It is a static site generated website, using [Zola](https://www.getzola.org/) for generation, and [Pico CSS](https://picocss.com/) for styling.
It is a static site generated website, using [Zola](https://www.getzola.org/)
for generation, and [Pico CSS](https://picocss.com/) for styling.

# Setup

- Installation instrucitons for [zola are here](https://www.getzola.org/documentation/getting-started/installation/). It is just a binary file you either add to your path, or install via package manager!
- We get Pico CSS from NPM, so you need to [install node](https://nodejs.org) if you don't already have it.
- Then you can just `npm install` to get Pico CSS
- Installation instructions for
[zola are here](https://www.getzola.org/documentation/getting-started/installation/).
It is just a binary file you either add to your path, or install via package
manager!
- We get Pico CSS from NPM, so you need to [install node](https://nodejs.org) if
you don't already have it.
- Then you can just `npm ci` to get Pico CSS

# Running the site

From the [Zola CLI usage docs](https://www.getzola.org/documentation/getting-started/cli-usage/)
> [Zola only has 4 commands: `init`, `build`, `serve` and `check`.](https://www.getzola.org/documentation/getting-started/cli-usage/)

So you just need to run `zola serve` to compile and run the site on a local web server.
From the
[Zola CLI usage docs](https://www.getzola.org/documentation/getting-started/cli-usage/)

> [Zola only has 4 commands: `init`, `build`, `serve` and `check`.](https://www.getzola.org/documentation/getting-started/cli-usage/)

So you just need to run `zola serve` to compile and run the site on a local web
server.