diff --git a/README.md b/README.md index d2fb5e810436d..83825ae4c7f19 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ - # Academic Pages ![pages-build-deployment](https://github.com/academicpages/academicpages.github.io/actions/workflows/pages/pages-build-deployment/badge.svg) Academic Pages is a Github Pages template for academic websites. +`jekyll serve -l -H localhost` # Getting Started 1. Register a GitHub account if you don't have one and confirm your e-mail (required!) -1. Click the "Use this template" button in the top right. -1. On the "New repository" page, enter your repository name as "[your GitHub username].github.io", which will also be your website's URL. -1. Set site-wide configuration and add your content. -1. Upload any files (like PDFs, .zip files, etc.) to the `files/` directory. They will appear at https://[your GitHub username].github.io/files/example.pdf. -1. Check status by going to the repository settings, in the "GitHub pages" section -1. (Optional) Use the Jupyter notebooks or python scripts in the `markdown_generator` folder to generate markdown files for publications and talks from a TSV file. +2. Click the "Use this template" button in the top right. +3. On the "New repository" page, enter your repository name as "[your GitHub username].github.io", which will also be your website's URL. +4. Set site-wide configuration and add your content. +5. Upload any files (like PDFs, .zip files, etc.) to the `files/` directory. They will appear at https://[your GitHub username].github.io/files/example.pdf. +6. Check status by going to the repository settings, in the "GitHub pages" section +7. (Optional) Use the Jupyter notebooks or python scripts in the `markdown_generator` folder to generate markdown files for publications and talks from a TSV file. See more info at https://academicpages.github.io/ @@ -23,13 +23,13 @@ See more info at https://academicpages.github.io/ When you are initially working your website, it is very useful to be able to preview the changes locally before pushing them to GitHub. To work locally you will need to: 1. Clone the repository and made updates as detailed above. -1. Make sure you have ruby-dev, bundler, and nodejs installed: `sudo apt install ruby-dev ruby-bundler nodejs` -1. Run `bundle install` to install ruby dependencies. If you get errors, delete Gemfile.lock and try again. -1. Run `jekyll serve -l -H localhost` to generate the HTML and serve it from `localhost:4000` the local server will automatically rebuild and refresh the pages on change. +2. Make sure you have ruby-dev, bundler, and nodejs installed: `sudo apt install ruby-dev ruby-bundler nodejs` +3. Run `bundle install` to install ruby dependencies. If you get errors, delete Gemfile.lock and try again. +4. Run `jekyll serve -l -H localhost` to generate the HTML and serve it from `localhost:4000` the local server will automatically rebuild and refresh the pages on change. If you are running on Linux it may be necessary to install some additional dependencies prior to being able to run locally: `sudo apt install build-essential gcc make` -# Maintenance +# Maintenance Bug reports and feature requests to the template should be [submitted via GitHub](https://github.com/academicpages/academicpages.github.io/issues/new/choose). For questions concerning how to style the template, please feel free to start a [new discussion on GitHub](https://github.com/academicpages/academicpages.github.io/discussions). diff --git a/_pages/cv.md b/_pages/cv.md index 59bd03bdfb836..b4ea39a98d0d7 100644 --- a/_pages/cv.md +++ b/_pages/cv.md @@ -129,6 +129,6 @@ Skills Publications ============ -