This template is designed to provide an easy way to create academic webpages. The goal is to separate content from form and to lower the barrier for scientists to create their webpages.
This way you can simply add your information and content and everything else is done for you. This template is heavily influenced by academicpages.github.io (structure and content) and Academia (doable in pelican).
This blog is created with Pelican which uses Python. The template was created so that it’s easy to deyloy to Github Pages, but you can make “simple” modifications to deploy it on other services (see the pelican documentation).
- Fork this Github repo
- Clone this repo on your computer
- Install the prerequisites
You will need to install pelican and the dependencies used to built
your website. The easiest way is to install from the requirements file.
pip install -r requirements.txt - Add your content (see below)
- Build and preview your website These are the instructions from the official pelican docs. I prefer the approach using Make, but you will need to install Make.
- Deploy your website to Github These are pelican official docs from the official pelican docs. I prefer using Make for this too.
You need to modify the pelicanconf.py file for adding the information
about your website. Here you can add your name (author), the name
of your website, your links, and links to your social media.
- To add new pages, just create new ones and add content.
- New pages are added to the menu-bar. You will need to add an
ordertag to specify the order of the page (see the existing pages for an example).
Just write the content and appropriate metadata to the pages.
All the available pelican themes have been added to the folder themes. If
you wish to change the theme of your site, just specify the name of the
theme that you want in the pelicanconf.py.
Please read the pelican documentation for learning how to modify the website’s looks and structure.
All contributions are welcome!
You can help out by writing documentation or tutorials on how to modify certain things, report bugs or errors, fixing bugs or by providing ideas.
If you encounter any errors while building your website, please read the pelican documentation to find out if it’s something that ocurred while adding your content, some issue with pelican itself, or its related to how this project configures things.
Your are welcome to communicate any errors by submitting an issue on Github.
To fix bugs, clone the repository, add your contribution, and submit a pull request.
If have suggestions on how to improve the website design (e.g., default tabs, theme, etc.), please open an issue on Github or email me.
This project was developed by Mario E. Bermonti-Perez as part of his academic research and activities. Feel free to contact me at mbermonti@psm.edu or mbermonti1132@gmail.com
This project is licensed under the GPL License. See the LICENSE.txt file for details.