Skip to content

Latest commit

 

History

History
280 lines (176 loc) · 8.7 KB

README-old.md

File metadata and controls

280 lines (176 loc) · 8.7 KB
Raw

http://maruan.alshedivat.com (https://alshedivat.github.io/al-folio/)

Resources

Asynchronous channel

Zoom rooms

Collaborative whiteboard (miro)

Github

Projects

Boards

Tasks and Issues

(#### Assign labels)

(#### Assign people)

Repos

Shared documents

ITU document server

Mailing list

Calendar

User stories

Create a new workstream (coordinator)

  1. Create mailing list

  2. Create calendar

  3. Create meeting series on Zoom

  4. Create asynchronous channel (discord/slack)

  5. Create project.md in _projects

  6. Fill out with above info + descriptipon

  7. Add project (project card)

  8. Add project image for full text

  9. Create "projectname".bib in _bibliography

Insert bibitems of related publications

  1. Have known contributors fill out the contributor template (including yourself) and add to repo

Update workstream resources (coordinator)

Modify resources

See "Create a new workstream (coordinator)"

Update project.md

Go to the repo ... and modify markdown

Add publications

Add bibitems to "projectname".bib

Join a Project / Workstream (contributor)

  1. Add personal information

    Add Name

    Add Affiliation

    Add Brief Profile

  2. Subscribe to project mailing list

    Add Email Id

  3. Join channel

    Add me to Git Hub (Project Repo)

    Add me to Trello Board (Project Management Board)

    Add me to Miro Board (White Board)

    Add me to Zoom (Video Conferencing tool)

    Add me to Slack (Chat / Communication channel)

    Add me to Discord (Chat / Communication channel)

  4. Add your contributor info to repo

    Add your role (Project Driver/Lead/Principal Investigator, Project Developer, Project Associate)

Preliminaries

Have Ruby and Bundler installed on your system (hint: for ease of managing ruby gems, consider using rbenv)

For more about how to use Jekyll, check out this tutorial. Why Jekyll? Read this blog post!

Workflow

IMAGE/Graph

Steps

  1. git pull
  2. Edit content in markdown (see categories below)
  3. Save
  4. bundle exec jekyll build
  5. git add .
  6. git commit -m "..."
  7. git push

...current scenario

  1. login to ftp
  2. transfer _site folder content

...future scenario 1

  1. ssh into webserver
  2. git pull

...future scenario 2

  1. automated script ()upon new commit)
    1. sshes into webserver
    2. git pull

...future scenario 3

  1. automated script (upon commit)
    1. bundle exec jekyll build
    2. git add .
    3. git commit
    4. sshes into webserver
    5. git pull upon new commit in github

Adding content

Pages

Projects

Posts

News

Publications

Housekeeping

Everyone

Project drivers

Contributors

Installation

Assuming you do

$ git clone https://github.com/aiaudit-org/website.git
$ cd website
$ bundle install
$ bundle exec jekyll serve

to have a look at the website locally.

Alternatively you can use the .devcontainer functionality in VS Code. Inside the container simply run

$ bundle exec jekyll serve

Now, you can add contents in markdown. When you are done

Features

Publications

Your publications page is generated automatically from your BibTex bibliography. Simply edit _bibliography/papers.bib. You can also add new *.bib files and customize the look of your publications however you like by editing _pages/publications.md.

Keep meta-information about your co-authors in _data/coauthors.yml and Jekyll will insert links to their webpages automatically.

Collections

This Jekyll theme implements collections to let you break up your work into categories. The theme comes with two default collections: news and projects. Items from the news collection are automatically displayed on the home page. Items from the projects collection are displayed on a responsive grid on projects page.

You can easily create your own collections, apps, short stories, courses, or whatever your creative work is. To do this, edit the collections in the _config.yml file, create a corresponding folder, and create a landing page for your collection, similar to _pages/projects.md.

Layouts

al-folio comes with stylish layouts for pages and blog posts.

The iconic style of Distill

The theme allows you to create blog posts in the distill.pub style:

For more details on how to create distill-styled posts using <d-*> tags, please refer to the example.

Full support for math & code

al-folio supports fast math typesetting through KaTeX and code syntax highlighting using GitHub style:

Photos

Photo formatting is made simple using Bootstrap's grid system. Easily create beautiful grids within your blog posts and project pages:

Other features

Theming

Six beautiful theme colors have been selected to choose from. The default is purple, but you can quickly change it by editing $theme-color variable in the _sass/_themes.scss file. Other color variables are listed there as well.

Social media previews

al-folio supports preview images on social media. To enable this functionality you will need to set serve_og_meta to true in your _config.yml. Once you have done so, all your site's pages will include Open Graph data in the HTML head element.

You will then need to configure what image to display in your site's social media previews. This can be configured on a per-page basis, by setting the og_image page variable. If for an individual page this variable is not set, then the theme will fall back to a site-wide og_image variable, configurable in your _config.yml. In both the page-specific and site-wide cases, the og_image variable needs to hold the URL for the image you wish to display in social media previews.

Contributing

Contributions to al-folio are very welcome! Before you get started, please take a look at the guidelines.

If you would like to improve documentation, add your webpage to the list below, or fix a minor inconsistency or bug, please feel free to send a PR directly to master. For more complex issues/bugs or feature requests, please open an issue using the appropriate template.

FAQ

Here are some frequently asked questions. If you have a different question, please ask on gitter.

  1. Q: When I preview my website locally everything looks great, but when I deploy it on GitHub bibliography Liquid tags are not recognized. How do I fix this?
    A: GitHub Pages rendering does not support certain Jekyll plugins, and jekyll-scholar that we use to render bibliography is one of them. Please make sure you deploy your website to GitHub using bin/deploy script that circumvents the issue.

  2. Q: When I deploy my fork of al-folio, it says Deployed successfully! But when I open <my-github-username>.github.io, I get Page not found (404) error. How do I fix this?
    A: For personal webpages, please run bin/deploy --user. (See also relevant past issues: #5, #49, #86.)

License

The theme is available as open source under the terms of the MIT License.

Originally, al-folio was based on the *folio theme (published by Lia Bogoev and under the MIT license). Since then, it got a full re-write of the styles and many additional cool features.