hbueno / website-1

This is the source code for my personal site

Home Page:https://www.leouieda.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Souce code for leouieda.com

build-html Powered by Urubu

This is the source code for my personal site leouieda.com.

Dependencies

You'll need to install Urubu and all it's dependencies to build the site. I have been using Python 3.8 for the build. See environment.yml for the complete dependency list.

You can create a conda environment with all required dependencies by running conda env create in the root of the repository. To activate the environment and run the build use source activate urubu.

Compiling the site

Use the Makefile:

make
make serve

The command make serve will start a simple server at the _build folder where the built HTML files are. Point your browser to http://localhost:8008/ to view the site. The server runs in the background so you can continue working on the site.

The theme

The website theme is made using bootstrap and tweaked from the Cosmo Bootswatch theme. Icons are provided by FontAwesome and Academicons.

The Jinja2 templates and CSS are located in the _layouts and css folders. I really should make this theme more generic and provide it to the world. But, you know, time and things. You can still use it by copying the folders to your own project. I can't guarantee that things will work without my specific folder structure.

Adding an article/talk/course/software

The papers, talks, courses and software entries are .md files in the corresponding folders. The site theme takes a lot of extra metadata in the post to make the "Info" section of each entry.

To add a new entry, create the .md file in the corresponding folder.

Metadata for entries

The template makes extensive use of metadata entries for pages. You can specify things like the DOI, Github repository, etc and the template will include it in the publication side bar. See the existing publications for examples.

Automatic deploy with GitHub Actions

The site is automatically built and deployed to leouieda/leouieda.github.com every time a commit is pushed to the master branch. See files .github/workflows/build.yml.

License

Creative Commons License Except were otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License.

All source code is distributed under the BSD 3-clause License.

About

This is the source code for my personal site

https://www.leouieda.com

License:Other


Languages

Language:HTML 65.7%Language:CSS 29.7%Language:Python 4.5%Language:Makefile 0.2%