Skip to content
README.md 1.17 KiB
Newer Older
Matt Spencer's avatar
Matt Spencer committed
![Build Status](https://gitlab.arm.com/soafee/website/badges/main/pipeline.svg)
GitLab's avatar
GitLab committed
---

Matt Spencer's avatar
Matt Spencer committed
This repositoy holds the sources for the soafee.io website.
GitLab's avatar
GitLab committed

Matt Spencer's avatar
Matt Spencer committed
A build of the website is trigged by a merge into the main branch of this repository.
GitLab's avatar
GitLab committed

Matt Spencer's avatar
Matt Spencer committed
The website is built using [Hugo].
GitLab's avatar
GitLab committed

## Building locally

To work locally with this project, you'll have to follow the steps below:

1. Fork, clone or download this project
1. [Install][] Hugo
1. Preview your project: `hugo server`
1. Add content
1. Generate the website: `hugo` (optional)

Read more at Hugo's [documentation][].

### Preview your site

If you clone or download this project to your local computer and run `hugo server`,
your site can be accessed under `localhost:1313/hugo/`.

The theme used is adapted from http://themes.gohugo.io/beautifulhugo/.

[ci]: https://about.gitlab.com/gitlab-ci/
[hugo]: https://gohugo.io
[install]: https://gohugo.io/overview/installing/
[documentation]: https://gohugo.io/overview/introduction/
[userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages
[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages
[post]: https://about.gitlab.com/2016/04/07/gitlab-pages-setup/#custom-domains