|
| 1 | +# hkunlp.github.io |
| 2 | +A new website for HKU NLP group (under construction). For now this page will host our blog posts and our group index page. |
| 3 | +Feel free to add blogs, news & new publications to our group page. :) |
| 4 | + |
| 5 | +## Lighthouse PageSpeed Insights |
| 6 | + |
| 7 | +Run the website! |
| 8 | + |
| 9 | +#### Local Setup (Standard) |
| 10 | + |
| 11 | +Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (*hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)*), first [fork](https://guides.github.com/activities/forking/) the theme from `github.com:alshedivat/al-folio` to `github.com:<your-username>/<your-repo-name>` and do the following: |
| 12 | + |
| 13 | +```bash |
| 14 | +$ git clone git@github.com:<your-username>/<your-repo-name>.git |
| 15 | +$ cd <your-repo-name> |
| 16 | +$ bundle install |
| 17 | +$ bundle exec jekyll serve |
| 18 | +``` |
| 19 | + |
| 20 | +Now, feel free to customize the theme however you like (don't forget to change the name!). |
| 21 | +After you are done, **commit** your final changes. |
| 22 | + |
| 23 | +--- |
| 24 | + |
| 25 | +## Features |
| 26 | + |
| 27 | +### News |
| 28 | + |
| 29 | +For new news entry, follow the stye in _news folder. |
| 30 | + |
| 31 | +### Publications |
| 32 | + |
| 33 | +Your publications page is generated automatically from your BibTex bibliography. |
| 34 | +Simply edit `_bibliography/papers.bib`. |
| 35 | +You can also add new `*.bib` files and customize the look of your publications however you like by editing `_pages/publications.md`. |
| 36 | + |
| 37 | +<p align="center"><img src="https://raw.githubusercontent.com/alshedivat/al-folio/master/assets/img/publications-screenshot.png" width=800></p> |
| 38 | + |
| 39 | +<details><summary>(click to expand) <strong>Author annotation:</strong></summary> |
| 40 | + |
| 41 | +In publications, the author entry for yourself is identified by string `scholar:last_name` and string array `scholar:first_name` in `_config.yml`: |
| 42 | +``` |
| 43 | +scholar: |
| 44 | + last_name: Einstein |
| 45 | + first_name: [Albert, A.] |
| 46 | +``` |
| 47 | +If the entry matches the last name and one form of the first names, it will be underlined. |
| 48 | +Keep meta-information about your co-authors in `_data/coauthors.yml` and Jekyll will insert links to their webpages automatically. |
| 49 | +The coauthor data format in `_data/coauthors.yml` is as follows, |
| 50 | +``` |
| 51 | +"Adams": |
| 52 | + - firstname: ["Edwin", "E.", "E. P.", "Edwin Plimpton"] |
| 53 | + url: https://en.wikipedia.org/wiki/Edwin_Plimpton_Adams |
| 54 | +
|
| 55 | +"Podolsky": |
| 56 | + - firstname: ["Boris", "B.", "B. Y.", "Boris Yakovlevich"] |
| 57 | + url: https://en.wikipedia.org/wiki/Boris_Podolsky |
| 58 | +
|
| 59 | +"Rosen": |
| 60 | + - firstname: ["Nathan", "N."] |
| 61 | + url: https://en.wikipedia.org/wiki/Nathan_Rosen |
| 62 | +
|
| 63 | +"Bach": |
| 64 | + - firstname: ["Johann Sebastian", "J. S."] |
| 65 | + url: https://en.wikipedia.org/wiki/Johann_Sebastian_Bach |
| 66 | +
|
| 67 | + - firstname: ["Carl Philipp Emanuel", "C. P. E."] |
| 68 | + url: https://en.wikipedia.org/wiki/Carl_Philipp_Emanuel_Bach |
| 69 | +``` |
| 70 | +If the entry matches one of the combinations of the last names and the first names, it will be highlighted and linked to the url provided. |
| 71 | + |
| 72 | +</details> |
| 73 | + |
| 74 | +<details><summary>(click to expand) <strong>Buttons (through custom bibtex keywords):</strong></summary> |
| 75 | + |
| 76 | +There are several custom bibtex keywords that you can use to affect how the entries are displayed on the webpage: |
| 77 | + |
| 78 | +- `abbr`: Adds an abbreviation to the left of the entry. You can add links to these by creating a venue.yaml-file in the _data folder and adding entries that match. |
| 79 | +- `abstract`: Adds an "Abs" button that expands a hidden text field when clicked to show the abstract text |
| 80 | +- `arxiv`: Adds a link to the Arxiv website (Note: only add the arxiv identifier here - the link is generated automatically) |
| 81 | +- `bibtex_show`: Adds a "Bib" button that expands a hidden text field with the full bibliography entry |
| 82 | +- `html`: Inserts a "HTML" button redirecting to the user-specified link |
| 83 | +- `pdf`: Adds a "PDF" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory) |
| 84 | +- `supp`: Adds a "Supp" button to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory) |
| 85 | +- `blog`: Adds a "Blog" button redirecting to the specified link |
| 86 | +- `code`: Adds a "Code" button redirecting to the specified link |
| 87 | +- `poster`: Adds a "Poster" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory) |
| 88 | +- `slides`: Adds a "Slides" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory) |
| 89 | +- `website`: Adds a "Website" button redirecting to the specified link |
| 90 | + |
| 91 | +You can implement your own buttons by editing the bib.html file. |
| 92 | + |
| 93 | +</details> |
| 94 | + |
| 95 | +--- |
| 96 | + |
0 commit comments