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

adds instructions so folks can build the website #363

Merged
merged 4 commits into from
Feb 3, 2025
+23 −1
Merged

adds instructions so folks can build the website #363

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3176983
adds instructions so folks can build the website
katyhuff Jan 30, 2025
26bff3f
double to single quotes
katyhuff Jan 30, 2025
fd388df
Update README.md
katyhuff Feb 3, 2025
d9a052b
Update README.md
katyhuff Feb 3, 2025
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
24 changes: 23 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -6,4 +6,26 @@ Fuel Cycles group.

## Building This Website

Coming soon...
It should be sufficient to do the following:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Install the build dependencies for the website. These include ruby, jekyll, and jekyll-scholar. Get started [here](https://jekyllrb.com/docs/installation/).

Clone the repo:
`git clone git@github.com:arfc/arfc.github.io`

Make your way to the top level of the source branch:
`cd arfc.github.io && git checkout source`

Install the gems:
`bundle install`

Build and serve the site locally:
`bundle exec jekyll serve`

The terminal will report that your website is being served at localhost:4000.
Navigate your browser there and you should see the webpage.

## Advanced build and push
Do everything in the previous section. If everything looks ok on preview,
execute:
`rake publish`

The built site will be committed to master and force pushed up to the website.