Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lenpaul/academic
A Jekyll theme for academia
https://github.com/lenpaul/academic
github-pages jekyll jekyll-blog jekyll-site jekyll-template jekyll-theme jekyll-website minimalist
Last synced: 5 days ago
JSON representation
A Jekyll theme for academia
- Host: GitHub
- URL: https://github.com/lenpaul/academic
- Owner: LeNPaul
- License: mit
- Created: 2016-05-24T16:50:15.000Z (over 8 years ago)
- Default Branch: gh-pages
- Last Pushed: 2023-04-07T00:43:44.000Z (almost 2 years ago)
- Last Synced: 2024-04-24T02:45:01.846Z (9 months ago)
- Topics: github-pages, jekyll, jekyll-blog, jekyll-site, jekyll-template, jekyll-theme, jekyll-website, minimalist
- Language: HTML
- Homepage: http://lenpaul.github.io/academic/
- Size: 60.7 MB
- Stars: 137
- Watchers: 3
- Forks: 149
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# academic
### A Jekyll theme for academia
A Jekyll theme designed for academia, although you can use it for almost any other purpose as well:
* Showcase your research interests, publications, your curriculum vitae, the people in your research group, and your contact information.
* Manage courses that you are teaching.
* Provide updates to your students and faulty.
For a guide on how to deploy a Jekyll site using GitHub Pages, please check out [this article](https://paulle.ca/jekyll-tutorials/deploy-jekyll-site-github-pages).
If you like my work then please consider supporting me with [Ko-fi](https://ko-fi.com/paulle).
## Installation
### Ruby Gem Method
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "academic-jekyll-theme"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: academic-jekyll-theme
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install academic-jekyll-theme
## Usage
### Layouts
The following sections describe usage instructions for this Jekyll theme,including available layouts, includes, sass and/or assets.
#### Home
The `_layouts/home.html` layout defines the home page for this theme. An introduction to your research group or to yourself can be provided, along with a list of featured publications. There is also a section for providing any updates through posts placed in the `_posts` directory.
#### People
The `_layouts/people.html` layout can be used to showcase and describe people in your research group. People are defined in the `_data/settings.yml` file, and markdown pages for each person with the `_layouts/page.html` layout can be placed in the `people` directory.
#### Publications
The `_layouts/publications.html` layout can be used to showcase selected publications, or the entire catalogue of publications. Direct links to the paper can be used, or a PDF copy of the paper can be served. Publications are defined in the `_data/publications.yml` file, and any PDF files that are served can be placed in the `publications` directory.
#### Courses
The `_layouts/courses.html` layout can be used to showcase courses that were taught in the past or are currently being taught. Courses are defined in the `_data/settings.yml` file, and markdown pages for each course with the `_layouts/page.html` layout can be placed in the `courses` directory. Related course material, such as PDF files, can also be placed in the `courses` directory in a subdirectory with the same name as the corresponding course.
#### CV
The `_layouts/cv.html` layout can be used to showcase a curriculum vitae. The sections of the cv are defined in the `_data/cv` directory, where each section has its own `.yml` file.
#### Contact
The `_layouts/contact.html` layout can be used to provide contact information for the research group or the people that lead the research group. Contact information is defined in the `_data/settings.yml` file.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/LeNPaul/academic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Development
To set up your environment to develop this theme, run `bundle install`, then run `bundle exec jekyll serve`, and open your browser at `http://localhost:4000`. This starts a Jekyll server using this theme. Make changes to the pages, documents, data, etc. like normal to test this theme's contents. As you make modifications to this theme the site will regenerate and you should see the changes in the browser after a refresh.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).