https://github.com/santisoler/website
Source code for building my personal website. Powered by Urubu.
https://github.com/santisoler/website
Last synced: 1 day ago
JSON representation
Source code for building my personal website. Powered by Urubu.
- Host: GitHub
- URL: https://github.com/santisoler/website
- Owner: santisoler
- License: cc-by-4.0
- Created: 2019-03-23T19:48:14.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T15:50:43.000Z (over 1 year ago)
- Last Synced: 2025-02-01T22:29:11.767Z (11 months ago)
- Language: HTML
- Homepage: https://www.santisoler.com
- Size: 29.5 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Source code to build my personal website
[](https://github.com/santisoler/website/actions)
[](http://urubu.jandecaluwe.com/)
This is the source code for
[www.santisoler.com](https://www.santisoler.com).
## Dependencies
The website is build using [Urubu](http://urubu.jandecaluwe.com/) (a Python module for
building static websites).
An easy way to get it installed with all its dependencies is through conda environemnts.
Install the [Anaconda](https://www.anaconda.com/) distribution and create a conda
environment from the `environment.yml` file:
```
conda env create -f environment.yml
```
Once all packages have been installed, you can change to the new `urubu` environment
using:
```
conda activate urubu
```
## How to compile and run it locally
Using `make` you can compile the website: Urubu will create a `_build` directory where
the final HTML code of the website will be located.
Then we can run `make serve` to serve the website locally. Open your browser on
http://localhost:8000 to view it.
## Continuous Integration and Deployment
After a new commit is pushed into the `master` branch, the website is automatically
build by [GitHub Actions](https://github.com/features/actions) and deployed into
[santisoler/santisoler.github.io](https://www.github.com/santisoler/santisoler.github.io).
The GitHub actions workflow is configured on `.github/workflows/build.yml`.
## Adding a new publication
When a new publication wants to be uploaded you have to create a Markdown file inside
`publications` folder which should have the following format:
```markdown
---
title:
layout: publication
date:
author:
inreview:
journal:
name:
url:
doi:
open_access: false
preprint:
archive:
url:
doi:
code:
repo:
url:
supplement:
doi:
download:
read:
title:
url:
thumbnail:
citation.md: |
Citation of the article in Markdown
---
```
You need to add a thumbnail for the publication that will appear on the pages
that lists all publications. The path to the thumbnail should be passed to the
`thumbnail` entry.
We can change the behaviour of the _Download_ button by specifying the source
for the article through the `download` entry. We could pass `preprint` or
`journal`. If `download` is empty, the button won't be created.
We can specify if the article is under peer-review process by passing `inreview`
as `true`.
## Adding a new presentation
```markdown
---
title:
layout: presentation
date:
author:
meeting:
name:
url:
organizer:
name:
url:
code:
repo:
url:
thumbnail:
license:
doi:
---
```
## Adding a new teaching entry
```markdown
---
title:
layout: teaching
date:
end_date:
author:
institution:
name:
url:
website:
name:
url:
thumbnail:
---
```
## Acknowledgments
The source code have been written by [santisoler](https://www.santisoler.com) based on
[Urubu's Quickstart Page](https://github.com/jandecaluwe/urubu-quickstart/) and inspired
on [leouieda.com](https://www.leouieda.com).
## License
This work is licensed under a [Creative Commons Attribution 4.0 International
License][cc-by].
[![CC BY 4.0][cc-by-image]][cc-by]
[cc-by]: http://creativecommons.org/licenses/by/4.0/
[cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png