Example Astro website using GitLab Pages.
Learn more about GitLab Pages at https://pages.gitlab.io and the official documentation https://docs.gitlab.com/ce/user/project/pages/.
Table of Contents generated with DocToc
This project's static Pages are built by GitLab CI, following the steps
defined in .gitlab-ci.yml
To work locally with this project, you'll have to follow the steps below:
- Fork, clone or download this project
- Install dependencies:
npm install
- Preview your project while making changes:
npm run start
- Add content
- To simulate a static build, run
npm run build
. This is not required. - Commit & push your changes. GitLab will tigger a static build as instructed by the
.gitlab-ci.yml
Read more at Astro's [documentation][https://docs.astro.build/en/getting-started/].
To use this project as your user/group website, you will need one additional
step: just rename your project to namespace.gitlab.io
, where namespace
is
your username
or groupname
. This can be done by navigating to your
project's Settings.
Read more about user/group Pages and project Pages.
If you forked this project for your own use, please go to your project's Settings and remove the forking relationship, which won't be necessary unless you want to contribute back to the upstream project.