ItsDrike/itsdrike.com
1
0
Fork 0
mirror of https://github.com/ItsDrike/itsdrike.com.git synced 2025-01-23 20:14:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve readme

Browse source
This commit is contained in:
ItsDrike 2022-05-14 20:35:07 +02:00
parent 7fc9d978dd
commit 955d6cb0cb
No known key found for this signature in database
GPG key ID: B014E761034AF742
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -9,10 +9,16 @@ This is the source code for my personal website, hosted on <https://itsdrike.com
The website is built using [hugo](https://gohugo.io/), but you will also need `npm`, since it provides easy way to version control the needed packages. These include things such as [Bootstrap SASS](https://getbootstrap.com/docs/5.0/customize/sass/), [Font Awesome (Free)](https://fontawesome.com/) and [JQuery](https://jquery.com/).
After all NPM requirements are satisfied, to build the static webpage and hugo is installed, run [`./scripts/build.sh`](./scripts/build.sh),
which will create a `./public` directory, which will contain all static files and can be used as a location for the file server.
After all NPM requirements are satisfied, you will also need to synchronize to git submodules, to obtain additional themes.
You can then use any file server of your liking to make the webpage available, if you want to stick to hugo, you can use a custom script, that runs the build script automatically and then starts the hugo server for you: [`scripts/server.sh`](./scripts/server.sh). By default, this will use <http://localhost:1313>, but you can pass hugo server arguments just like you would normally, so you can do:
To then build the static webpage using hugo, run [`./scripts/build.sh`](./scripts/build.sh),
which will create a `./public` directory, with all static files and can be hosted with a file server (such as nginx, or
apache).
If you want to test out the webpage locally, or if you prefer to stick purely with hugo, even for deployment, instead
of building the webpage, you can use hugo's server functionality and run the [`scripts/server.sh`](./scripts/server.sh)
script instead of the build script. By default, this will host the server on <http://localhost:1313>, but you can pass
hugo server arguments to the script, just like you would with running bare `hugo server`. For example:
```
$ ./scripts/server.sh --bind 0.0.0.0 --port 80 --baseURL https://itsdrike.com/
```