Delete unused files
This commit is contained in:
parent
951c2a4e52
commit
cf9eedbb4c
|
@ -1,25 +0,0 @@
|
|||
# Contributing to al-folio
|
||||
Thank you for considering to contribute to al-folio!
|
||||
|
||||
|
||||
## Pull Requests
|
||||
We welcome your pull requests (PRs).
|
||||
For minor fixes (e.g., documentation improvements), feel free to submit a PR directly.
|
||||
If you would like to implement a new feature or a bug, please make sure you (or someone else) has opened an appropriate issue first; in your PR, please mention the issue it addresses.
|
||||
|
||||
|
||||
## Issues
|
||||
We use GitHub issues to track bugs and feature requests.
|
||||
Before submitting an issue, please make sure:
|
||||
|
||||
1. You have read [the FAQ section](https://github.com/alshedivat/al-folio#faq) of the README and your question is NOT addressed there.
|
||||
2. You have done your best to ensure that your issue is NOT a duplicate of one of [the previous issues](https://github.com/alshedivat/al-folio/issues).
|
||||
3. Your issue is either a bug (unexpected/undesirable behavior) or a feature request.
|
||||
If it is just a question, please ask it in the [Discussions](https://github.com/alshedivat/al-folio/discussions) forum.
|
||||
|
||||
When submitting an issue, please make sure to use the appropriate template.
|
||||
|
||||
|
||||
## License
|
||||
By contributing to al-folio, you agree that your contributions will be licensed
|
||||
under the LICENSE file in the root directory of the source tree.
|
381
README.md
381
README.md
|
@ -1,381 +0,0 @@
|
|||
# al-folio
|
||||
|
||||
[](https://travis-ci.org/alshedivat/al-folio)
|
||||
[](https://alshedivat.github.io/al-folio/)
|
||||
[](https://github.com/alshedivat/al-folio/graphs/contributors/)
|
||||

|
||||

|
||||
[](https://github.com/alshedivat/al-folio)
|
||||
[](https://github.com/alshedivat/al-folio/fork)
|
||||
[](https://ko-fi.com/alshedivat)
|
||||
|
||||
A simple, clean, and responsive [Jekyll](https://jekyllrb.com/) theme for academics.
|
||||
If you like the theme, give it a star!
|
||||
|
||||
[](https://alshedivat.github.io/al-folio/)
|
||||
|
||||
|
||||
## User community
|
||||
|
||||
The vibrant community of **al-folio** users is growing!
|
||||
Academics around the world use this theme for their homepages, blogs, lab pages, as well as webpages for courses, workshops, conferences, meetups, and more.
|
||||
Check out the community webpages below.
|
||||
Feel free to add your own page(s) by sending a PR.
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>Academics</td>
|
||||
<td>
|
||||
<a href="http://maruan.alshedivat.com" target="_blank">★</a>
|
||||
<a href="https://www.cs.columbia.edu/~chen1ru/" target="_blank">★</a>
|
||||
<a href="https://maithraraghu.com" target="_blank">★</a>
|
||||
<a href="http://platanois.org" target="_blank">★</a>
|
||||
<a href="https://otiliastr.github.io" target="_blank">★</a>
|
||||
<a href="https://www.maths.dur.ac.uk/~sxwc62/" target="_blank">★</a>
|
||||
<a href="http://jessachandler.com/" target="_blank">★</a>
|
||||
<a href="https://mayankm96.github.io/" target="_blank">★</a>
|
||||
<a href="https://markdean.info/" target="_blank">★</a>
|
||||
<a href="https://kakodkar.github.io/" target="_blank">★</a>
|
||||
<a href="https://sahirbhatnagar.com/" target="_blank">★</a>
|
||||
<a href="https://spd.gr/" target="_blank">★</a>
|
||||
<a href="https://jay-sarkar.github.io/" target="_blank">★</a>
|
||||
<a href="https://aborowska.github.io/" target="_blank">★</a>
|
||||
<a href="https://aditisgh.github.io/" target="_blank">★</a>
|
||||
<a href="https://alexhaydock.co.uk/" target="_blank">★</a>
|
||||
<a href="https://alixkeener.net/" target="_blank">★</a>
|
||||
<a href="https://andreea7b.github.io/" target="_blank">★</a>
|
||||
<a href="https://rishabhjoshi.github.io/" target="_blank">★</a>
|
||||
<a href="https://sheelabhadra.github.io/" target="_blank">★</a>
|
||||
<a href="https://giograno.me/" target="_blank">★</a>
|
||||
<a href="https://immsrini.github.io/" target="_blank">★</a>
|
||||
<a href="https://apooladian.github.io/" target="_blank">★</a>
|
||||
<a href="https://chinmoy-dutta.github.io/" target="_blank">★</a>
|
||||
<a href="https://liamcli.com/" target="_blank">★</a>
|
||||
<a href="https://yoonholee.com/" target="_blank">★</a>
|
||||
<a href="https://zrqiao.github.io/" target="_blank">★</a>
|
||||
<a href="https://abstractgeek.github.io/" target="_blank">★</a>
|
||||
<a href="https://www.compphys.de/" target="_blank">★</a>
|
||||
<a href="https://julianstreyczek.github.io" target="_blank">★</a>
|
||||
<a href="https://sdaza.com" target="_blank">★</a>
|
||||
<a href="https://niweera.gq" target="_blank">★</a>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Labs</td>
|
||||
<td>
|
||||
<a href="https://www.haylab.caltech.edu/" target="_blank">★</a>
|
||||
<a href="https://sjkimlab.github.io/" target="_blank">★</a>
|
||||
<a href="https://systemconsultantgroup.github.io/scg-folio/" target="_blank">★</a>
|
||||
<a href="https://decisionlab.ucsf.edu/" target="_blank">★</a>
|
||||
<a href="https://programming-group.com/" target="_blank">★</a>
|
||||
<a href="https://sailing-lab.github.io/" target="_blank">★</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Courses</td>
|
||||
<td>
|
||||
CMU PGM (<a href="https://sailinglab.github.io/pgm-spring-2019/" target="_blank">S-19</a>) <br>
|
||||
CMU DeepRL (<a href="https://cmudeeprl.github.io/703website_f19/" target="_blank">F-19</a>, <a href="https://cmudeeprl.github.io/Spring202010403website/" target="_blank">S-20</a>, <a href="https://cmudeeprl.github.io/703website/" target="_blank">F-20</a>, <a href="https://cmudeeprl.github.io/403_website/"target="_blank">S-21</a>) <br>
|
||||
CMU MMML (<a href="https://cmu-multicomp-lab.github.io/mmml-course/fall2020/" target="_blank">F-20</a>) <br>
|
||||
CMU Distributed Systems (<a href="https://andrew.cmu.edu/course/15-440/" target="_blank">S-21</a>)
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Conferences & workshops</td>
|
||||
<td>
|
||||
ML Retrospectives (NeurIPS: <a href="https://ml-retrospectives.github.io/neurips2019/" target="_blank">2019</a>, <a href="https://ml-retrospectives.github.io/neurips2020/" target="_blank">2020</a>; ICML: <a href="https://ml-retrospectives.github.io/icml2020/" target="_blank">2020</a>) <br>
|
||||
HAMLETS (NeurIPS: <a href="https://hamlets-workshop.github.io/" target="_blank">2020</a>) <br>
|
||||
ICBINB (NeurIPS: <a href="https://i-cant-believe-its-not-better.github.io/" target="_blank">2020</a>, <a href="https://i-cant-believe-its-not-better.github.io/neurips2021/" target="_blank">2021</a>) <br>
|
||||
Neural Compression (ICLR: <a href="https://neuralcompression.github.io/" target="_blank">2021</a>)
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
## Best practices
|
||||
|
||||
[](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Falshedivat.github.io%2Fal-folio%2F&tab=desktop)
|
||||
|
||||
|
||||
## Getting started
|
||||
|
||||
For more about how to use Jekyll, check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/).
|
||||
Why Jekyll? Read [Andrej Karpathy's blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/)!
|
||||
|
||||
|
||||
### Installation
|
||||
|
||||
#### Local setup
|
||||
|
||||
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:
|
||||
|
||||
```bash
|
||||
$ git clone git@github.com:<your-username>/<your-repo-name>.git
|
||||
$ cd <your-repo-name>
|
||||
$ bundle install
|
||||
$ bundle exec jekyll serve
|
||||
```
|
||||
|
||||
Now, feel free to customize the theme however you like (don't forget to change the name!).
|
||||
After you are done, **commit** your final changes.
|
||||
|
||||
#### Deployment
|
||||
|
||||
Deploying your website to [GitHub Pages](https://pages.github.com/) is the most popular option.
|
||||
Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0.3.5), **al-folio** will automatically re-deploy your webpage each time you push new changes to your repository! :sparkles:
|
||||
|
||||
**For personal and organization webpages:**
|
||||
1. Rename your repository to `<your-github-username>.github.io` or `<your-github-orgname>.github.io`.
|
||||
2. In `_config.yml`, set `url` to `https://<your-github-username>.github.io` and leave `baseurl` empty.
|
||||
3. Set up automatic deployment of your webpage (see instructions below).
|
||||
4. Make changes, commit, and push!
|
||||
5. After deployment, the webpage will become available at `<your-github-username>.github.io`.
|
||||
|
||||
**For project pages:**
|
||||
1. In `_config.yml`, set `url` to `https://<your-github-username>.github.io` and `baseurl` to `/<your-repository-name>/`.
|
||||
2. Set up automatic deployment of your webpage (see instructions below).
|
||||
3. Make changes, commit, and push!
|
||||
4. After deployment, the webpage will become available at `<your-github-username>.github.io/<your-repository-name>/`.
|
||||
|
||||
**To enable automatic deployment:**
|
||||
1. Click on **Actions** tab and **Enable GitHub Actions**; do not worry about creating any workflows as everything has already been set for you.
|
||||
2. Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action.
|
||||
3. Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `master` branch, your repository should now have a newly built `gh-pages` branch.
|
||||
4. Finally, in the **Settings** of your repository, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). For more details, see [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source).
|
||||
|
||||
|
||||
<details><summary>(click to expand) <strong>Manual deployment to GitHub Pages:</strong></summary>
|
||||
|
||||
If you need to manually re-deploy your website to GitHub pages, run the deploy script from the root directory of your repository:
|
||||
```bash
|
||||
$ ./bin/deploy
|
||||
```
|
||||
uses the `master` branch for the source code and deploys the webpage to `gh-pages`.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>(click to expand) <strong>Deployment to another hosting server (non GitHub Pages):</strong></summary>
|
||||
|
||||
If you decide to not use GitHub Pages and host your page elsewhere, simply run:
|
||||
```bash
|
||||
$ bundle exec jekyll build
|
||||
```
|
||||
which will (re-)generate the static webpage in the `_site/` folder.
|
||||
Then simply copy the contents of the `_site/` foder to your hosting server.
|
||||
|
||||
**Note:** Make sure to correctly set the `url` and `baseurl` fields in `_config.yml` before building the webpage. If you are deploying your webpage to `your-domain.com/your-project/`, you must set `url: your-domain.com` and `baseurl: /your-project/`. If you are deploing directly to `your-domain.com`, leave `baseurl` blank.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>(click to expand) <strong>Deployment to a separate repository (advanced users only):</strong></summary>
|
||||
|
||||
**Note:** Do not try using this method unless you know what you are doing (make sure you are familiar with [publishing sources](https://help.github.com/en/github/working-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites)). This approach allows to have the website's source code in one repository and the deployment version in a different repository.
|
||||
|
||||
Let's assume that your website's publishing source is a `publishing-source` sub-directory of a git-versioned repository cloned under `$HOME/repo/`.
|
||||
For a user site this could well be something like `$HOME/<user>.github.io`.
|
||||
|
||||
Firstly, from the deployment repo dir, checkout the git branch hosting your publishing source.
|
||||
|
||||
Then from the website sources dir (commonly your al-folio fork's clone):
|
||||
```bash
|
||||
$ bundle exec jekyll build --destination $HOME/repo/publishing-source
|
||||
```
|
||||
|
||||
This will instruct jekyll to deploy the website under `$HOME/repo/publishing-source`.
|
||||
|
||||
**Note:** Jekyll will clean `$HOME/repo/publishing-source` before building!
|
||||
|
||||
The quote below is taken directly from the [jekyll configuration docs](https://jekyllrb.com/docs/configuration/options/):
|
||||
|
||||
> Destination folders are cleaned on site builds
|
||||
>
|
||||
> The contents of `<destination>` are automatically cleaned, by default, when the site is built. Files or folders that are not created by your site will be removed. Some files could be retained by specifying them within the `<keep_files>` configuration directive.
|
||||
>
|
||||
> Do not use an important location for `<destination>`; instead, use it as a staging area and copy files from there to your web server.
|
||||
|
||||
If `$HOME/repo/publishing-source` contains files that you want jekyll to leave untouched, specify them under `keep_files` in `_config.yml`.
|
||||
In its default configuration, al-folio will copy the top-level `README.md` to the publishing source. If you want to change this behaviour, add `README.md` under `exclude` in `_config.yml`.
|
||||
|
||||
**Note:** Do _not_ run `jekyll clean` on your publishing source repo as this will result in the entire directory getting deleted, irrespective of the content of `keep_files` in `_config.yml`.
|
||||
|
||||
</details>
|
||||
|
||||
#### Upgrading from a previous version
|
||||
|
||||
If you installed **al-folio** as described above, you can upgrade to the latest version as follows:
|
||||
|
||||
```bash
|
||||
# Assuming the current directory is <your-repo-name>
|
||||
$ git remote add upstream https://github.com/alshedivat/al-folio.git
|
||||
$ git fetch upstream
|
||||
$ git rebase upstream/v0.3.5
|
||||
```
|
||||
|
||||
If you have extensively customized a previous version, it might be trickier to upgrade.
|
||||
You can still follow the steps above, but `git rebase` may result in merge conflicts that must be resolved.
|
||||
See [git rebase manual](https://help.github.com/en/github/using-git/about-git-rebase) and how to [resolve conflicts](https://help.github.com/en/github/using-git/resolving-merge-conflicts-after-a-git-rebase) for more information.
|
||||
If rebasing is too complicated, we recommend to re-install the new version of the theme from scratch and port over your content and changes from the previous version manually.
|
||||
|
||||
### FAQ
|
||||
|
||||
Here are some frequently asked questions.
|
||||
If you have a different question, please ask using [Discussions](https://github.com/alshedivat/al-folio/discussions/categories/q-a).
|
||||
|
||||
1. **Q:** After I fork and setup the repo, I get a deployment error.
|
||||
Isn't the website supposed to correctly deploy automatically? <br>
|
||||
**A:** Yes, if you are using release `v0.3.5` or later, the website will automatically and correctly re-deploy right after your first commit.
|
||||
Please make some changes (e.g., change your website info in `_config.yml`), commit, and push.
|
||||
Make sure to follow [deployment instructions](https://github.com/alshedivat/al-folio#deployment) in the previous section.
|
||||
(Relevant issue: [209](https://github.com/alshedivat/al-folio/issues/209#issuecomment-798849211).)
|
||||
|
||||
2. **Q:** I am using a custom domain (e.g., `foo.com`).
|
||||
My custom domain becomes blank in the repository settings after each deployment.
|
||||
How do I fix that? <br>
|
||||
**A:** You need to add `CNAME` file to the `master` or `source` branch of your repository.
|
||||
The file should contain your custom domain name.
|
||||
(Relevant issue: [130](https://github.com/alshedivat/al-folio/issues/130).)
|
||||
|
||||
3. **Q:** My webpage works locally.
|
||||
But after deploying, it is not displayed correctly (CSS and JS is not loaded properly).
|
||||
How do I fix that? <br>
|
||||
**A:** Make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`.
|
||||
Set `url` to `https://<your-github-username>.github.io` or to `https://<your.custom.domain>` if you are using a custom domain.
|
||||
If you are deploying a personal or organization website, leave `baseurl` blank.
|
||||
If you are deploying a project page, set `baseurl: /<your-project-name>/`.
|
||||
|
||||
4. **Q:** Atom feed doesn't work. Why?
|
||||
<br>
|
||||
**A:** Make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`.
|
||||
RSS Feed plugin works with these correctly set up fields: `title`, `url`, `description` and `author`.
|
||||
Make sure to fill them in an appropriate way and try again.
|
||||
|
||||
## 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`.
|
||||
|
||||
<p align="center"><img src="https://raw.githubusercontent.com/alshedivat/al-folio/master/assets/img/publications-screenshot.png" width=800></p>
|
||||
|
||||
<details><summary>(click to expand) <strong>Author annotation:</strong></summary>
|
||||
|
||||
In publications, the author entry for yourself is identified by string `scholar:last_name` and string array `scholar:first_name` in `_config.yml`:
|
||||
```
|
||||
scholar:
|
||||
last_name: Einstein
|
||||
first_name: [Albert, A.]
|
||||
```
|
||||
If the entry matches the last name and one form of the first names, it will be underlined.
|
||||
Keep meta-information about your co-authors in `_data/coauthors.yml` and Jekyll will insert links to their webpages automatically.
|
||||
The coauthor data format in `_data/coauthors.yml` is as follows,
|
||||
```
|
||||
"Adams":
|
||||
- firstname: ["Edwin", "E.", "E. P.", "Edwin Plimpton"]
|
||||
url: https://en.wikipedia.org/wiki/Edwin_Plimpton_Adams
|
||||
|
||||
"Podolsky":
|
||||
- firstname: ["Boris", "B.", "B. Y.", "Boris Yakovlevich"]
|
||||
url: https://en.wikipedia.org/wiki/Boris_Podolsky
|
||||
|
||||
"Rosen":
|
||||
- firstname: ["Nathan", "N."]
|
||||
url: https://en.wikipedia.org/wiki/Nathan_Rosen
|
||||
|
||||
"Bach":
|
||||
- firstname: ["Johann Sebastian", "J. S."]
|
||||
url: https://en.wikipedia.org/wiki/Johann_Sebastian_Bach
|
||||
|
||||
- firstname: ["Carl Philipp Emanuel", "C. P. E."]
|
||||
url: https://en.wikipedia.org/wiki/Carl_Philipp_Emanuel_Bach
|
||||
```
|
||||
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.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
### 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.
|
||||
|
||||
<p align="center"><img src="https://raw.githubusercontent.com/alshedivat/al-folio/master/assets/img/projects-screenshot.png" width=700></p>
|
||||
|
||||
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](https://distill.pub/) style:
|
||||
|
||||
<p align="center"><a href="https://alshedivat.github.io/al-folio/blog/2018/distill/" target="_blank"><img src="https://raw.githubusercontent.com/alshedivat/al-folio/master/assets/img/distill-screenshot.png" width=700></a></p>
|
||||
|
||||
For more details on how to create distill-styled posts using `<d-*>` tags, please refer to [the example](https://alshedivat.github.io/al-folio/blog/2018/distill/).
|
||||
|
||||
#### Full support for math & code
|
||||
|
||||
**al-folio** supports fast math typesetting through [KaTeX](https://katex.org/) and code syntax highlighting using [GitHub style](https://github.com/jwarby/jekyll-pygments-themes):
|
||||
|
||||
<p align="center">
|
||||
<a href="https://alshedivat.github.io/al-folio/blog/2015/math/" target="_blank"><img src="https://raw.githubusercontent.com/alshedivat/al-folio/master/assets/img/math-screenshot.png" width=400></a>
|
||||
<a href="https://alshedivat.github.io/al-folio/blog/2015/code/" target="_blank"><img src="https://raw.githubusercontent.com/alshedivat/al-folio/master/assets/img/code-screenshot.png" width=400></a>
|
||||
</p>
|
||||
|
||||
#### Photos
|
||||
|
||||
Photo formatting is made simple using [Bootstrap's grid system](https://getbootstrap.com/docs/4.4/layout/grid/).
|
||||
Easily create beautiful grids within your blog posts and project pages:
|
||||
|
||||
<p align="center">
|
||||
<a href="https://alshedivat.github.io/al-folio/projects/1_project/">
|
||||
<img src="assets/img/photos-screenshot.png" width="75%">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
|
||||
### 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.
|
||||
|
||||
#### Atom (RSS-like) Feed
|
||||
It generates an Atom (RSS-like) feed of your posts, useful for Atom and RSS readers.
|
||||
The feed is reachable simply by typing after your homepage `/feed.xml`.
|
||||
E.g. assuming your website mountpoint is the main folder, you can type `yourusername.github.io/feed.xml`
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions to al-folio are very welcome!
|
||||
Before you get started, please take a look at [the guidelines](CONTRIBUTING.md).
|
||||
|
||||
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.
|
||||
|
||||
|
||||
## License
|
||||
|
||||
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
||||
|
||||
Originally, **al-folio** was based on the [\*folio theme](https://github.com/bogoli/-folio) (published by [Lia Bogoev](http://liabogoev.com) and under the MIT license).
|
||||
Since then, it got a full re-write of the styles and many additional cool features.
|
|
@ -1,72 +0,0 @@
|
|||
---
|
||||
---
|
||||
|
||||
@string{aps = {American Physical Society,}}
|
||||
|
||||
@book{einstein1956investigations,
|
||||
bibtex_show={true},
|
||||
title={Investigations on the Theory of the Brownian Movement},
|
||||
author={Einstein, Albert},
|
||||
year={1956},
|
||||
publisher={Courier Corporation,}
|
||||
}
|
||||
|
||||
@article{einstein1950meaning,
|
||||
abbr={AJP},
|
||||
bibtex_show={true},
|
||||
title={The meaning of relativity},
|
||||
author={Einstein, Albert and Taub, AH},
|
||||
journal={American Journal of Physics,},
|
||||
volume={18},
|
||||
number={6},
|
||||
pages={403--404},
|
||||
year={1950},
|
||||
publisher={American Association of Physics Teachers,}
|
||||
}
|
||||
|
||||
@article{PhysRev.47.777,
|
||||
abbr={PhysRev},
|
||||
title={Can Quantum-Mechanical Description of Physical Reality Be Considered Complete?},
|
||||
author={Einstein, A. and Podolsky, B. and Rosen, N.},
|
||||
abstract={In a complete theory there is an element corresponding to each element of reality. A sufficient condition for the reality of a physical quantity is the possibility of predicting it with certainty, without disturbing the system. In quantum mechanics in the case of two physical quantities described by non-commuting operators, the knowledge of one precludes the knowledge of the other. Then either (1) the description of reality given by the wave function in quantum mechanics is not complete or (2) these two quantities cannot have simultaneous reality. Consideration of the problem of making predictions concerning a system on the basis of measurements made on another system that had previously interacted with it leads to the result that if (1) is false then (2) is also false. One is thus led to conclude that the description of reality as given by a wave function is not complete.},
|
||||
journal={Phys. Rev.,},
|
||||
volume={47},
|
||||
issue={10},
|
||||
pages={777--780},
|
||||
numpages={0},
|
||||
year={1935},
|
||||
month={May},
|
||||
publisher=aps,
|
||||
doi={10.1103/PhysRev.47.777},
|
||||
url={http://link.aps.org/doi/10.1103/PhysRev.47.777},
|
||||
html={https://journals.aps.org/pr/abstract/10.1103/PhysRev.47.777},
|
||||
pdf={example_pdf.pdf},
|
||||
selected={true}
|
||||
}
|
||||
|
||||
@article{einstein1905molekularkinetischen,
|
||||
title={{\"U}ber die von der molekularkinetischen Theorie der W{\"a}rme geforderte Bewegung von in ruhenden Fl{\"u}ssigkeiten suspendierten Teilchen},
|
||||
author={Einstein, A.},
|
||||
journal={Annalen der physik,},
|
||||
volume={322},
|
||||
number={8},
|
||||
pages={549--560},
|
||||
year={1905},
|
||||
publisher={Wiley Online Library}
|
||||
}
|
||||
|
||||
@article{einstein1905movement,
|
||||
abbr={Ann. Phys.},
|
||||
title={Un the movement of small particles suspended in statiunary liquids required by the molecular-kinetic theory 0f heat},
|
||||
author={Einstein, A.},
|
||||
journal={Ann. Phys.,},
|
||||
volume={17},
|
||||
pages={549--560},
|
||||
year={1905}
|
||||
}
|
||||
|
||||
@article{einstein1905electrodynamics,
|
||||
title={On the electrodynamics of moving bodies},
|
||||
author={Einstein, A.},
|
||||
year={1905}
|
||||
}
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
layout: post
|
||||
date: 2015-10-22 15:59:00-0400
|
||||
inline: true
|
||||
---
|
||||
|
||||
A simple inline announcement.
|
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
layout: post
|
||||
title: A long announcement with details
|
||||
date: 2015-11-07 16:11:00-0400
|
||||
inline: false
|
||||
---
|
||||
|
||||
Announcements and news can be much longer than just quick inline posts. In fact, they can have all the features available for the standard blog posts. See below.
|
||||
|
||||
***
|
||||
|
||||
Jean shorts raw denim Vice normcore, art party High Life PBR skateboard stumptown vinyl kitsch. Four loko meh 8-bit, tousled banh mi tilde forage Schlitz dreamcatcher twee 3 wolf moon. Chambray asymmetrical paleo salvia, sartorial umami four loko master cleanse drinking vinegar brunch. <a href="https://www.pinterest.com">Pinterest</a> DIY authentic Schlitz, hoodie Intelligentsia butcher trust fund brunch shabby chic Kickstarter forage flexitarian. Direct trade <a href="https://en.wikipedia.org/wiki/Cold-pressed_juice">cold-pressed</a> meggings stumptown plaid, pop-up taxidermy. Hoodie XOXO fingerstache scenester Echo Park. Plaid ugh Wes Anderson, freegan pug selvage fanny pack leggings pickled food truck DIY irony Banksy.
|
||||
|
||||
#### Hipster list
|
||||
<ul>
|
||||
<li>brunch</li>
|
||||
<li>fixie</li>
|
||||
<li>raybans</li>
|
||||
<li>messenger bag</li>
|
||||
</ul>
|
||||
|
||||
Hoodie Thundercats retro, tote bag 8-bit Godard craft beer gastropub. Truffaut Tumblr taxidermy, raw denim Kickstarter sartorial dreamcatcher. Quinoa chambray slow-carb salvia readymade, bicycle rights 90's yr typewriter selfies letterpress cardigan vegan.
|
||||
|
||||
***
|
||||
|
||||
Pug heirloom High Life vinyl swag, single-origin coffee four dollar toast taxidermy reprehenderit fap distillery master cleanse locavore. Est anim sapiente leggings Brooklyn ea. Thundercats locavore excepteur veniam eiusmod. Raw denim Truffaut Schlitz, migas sapiente Portland VHS twee Bushwick Marfa typewriter retro id keytar.
|
||||
|
||||
> We do not grow absolutely, chronologically. We grow sometimes in one dimension, and not in another, unevenly. We grow partially. We are relative. We are mature in one realm, childish in another.
|
||||
> —Anais Nin
|
||||
|
||||
Fap aliqua qui, scenester pug Echo Park polaroid irony shabby chic ex cardigan church-key Odd Future accusamus. Blog stumptown sartorial squid, gastropub duis aesthetic Truffaut vero. Pinterest tilde twee, odio mumblecore jean shorts lumbersexual.
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
layout: post
|
||||
date: 2016-01-15 07:59:00-0400
|
||||
inline: true
|
||||
---
|
||||
|
||||
A simple inline announcement with Markdown emoji! :sparkles: :smile:
|
|
@ -1,30 +0,0 @@
|
|||
---
|
||||
layout: post
|
||||
title: a post with formatting and links
|
||||
date: 2015-03-15 16:40:16
|
||||
description: march & april, looking forward to summer
|
||||
tags: formatting links
|
||||
categories: sample-posts
|
||||
---
|
||||
Jean shorts raw denim Vice normcore, art party High Life PBR skateboard stumptown vinyl kitsch. Four loko meh 8-bit, tousled banh mi tilde forage Schlitz dreamcatcher twee 3 wolf moon. Chambray asymmetrical paleo salvia, sartorial umami four loko master cleanse drinking vinegar brunch. <a href="https://www.pinterest.com">Pinterest</a> DIY authentic Schlitz, hoodie Intelligentsia butcher trust fund brunch shabby chic Kickstarter forage flexitarian. Direct trade <a href="https://en.wikipedia.org/wiki/Cold-pressed_juice">cold-pressed</a> meggings stumptown plaid, pop-up taxidermy. Hoodie XOXO fingerstache scenester Echo Park. Plaid ugh Wes Anderson, freegan pug selvage fanny pack leggings pickled food truck DIY irony Banksy.
|
||||
|
||||
#### Hipster list
|
||||
<ul>
|
||||
<li>brunch</li>
|
||||
<li>fixie</li>
|
||||
<li>raybans</li>
|
||||
<li>messenger bag</li>
|
||||
</ul>
|
||||
|
||||
Hoodie Thundercats retro, tote bag 8-bit Godard craft beer gastropub. Truffaut Tumblr taxidermy, raw denim Kickstarter sartorial dreamcatcher. Quinoa chambray slow-carb salvia readymade, bicycle rights 90's yr typewriter selfies letterpress cardigan vegan.
|
||||
|
||||
<hr>
|
||||
|
||||
Pug heirloom High Life vinyl swag, single-origin coffee four dollar toast taxidermy reprehenderit fap distillery master cleanse locavore. Est anim sapiente leggings Brooklyn ea. Thundercats locavore excepteur veniam eiusmod. Raw denim Truffaut Schlitz, migas sapiente Portland VHS twee Bushwick Marfa typewriter retro id keytar.
|
||||
|
||||
<blockquote>
|
||||
We do not grow absolutely, chronologically. We grow sometimes in one dimension, and not in another, unevenly. We grow partially. We are relative. We are mature in one realm, childish in another.
|
||||
—Anais Nin
|
||||
</blockquote>
|
||||
|
||||
Fap aliqua qui, scenester pug Echo Park polaroid irony shabby chic ex cardigan church-key Odd Future accusamus. Blog stumptown sartorial squid, gastropub duis aesthetic Truffaut vero. Pinterest tilde twee, odio mumblecore jean shorts lumbersexual.
|
|
@ -1,47 +0,0 @@
|
|||
---
|
||||
layout: post
|
||||
title: a post with images
|
||||
date: 2015-05-15 21:01:00
|
||||
description: this is what included images could look like
|
||||
tags: formatting images
|
||||
categories: sample-posts
|
||||
---
|
||||
This is an example post with image galleries.
|
||||
|
||||
<div class="row mt-3">
|
||||
<div class="col-sm mt-3 mt-md-0">
|
||||
{% include figure.html path="assets/img/9.jpg" class="img-fluid rounded z-depth-1" %}
|
||||
</div>
|
||||
<div class="col-sm mt-3 mt-md-0">
|
||||
{% include figure.html path="assets/img/7.jpg" class="img-fluid rounded z-depth-1" %}
|
||||
</div>
|
||||
</div>
|
||||
<div class="caption">
|
||||
A simple, elegant caption looks good between image rows, after each row, or doesn't have to be there at all.
|
||||
</div>
|
||||
|
||||
Images can be made zoomable.
|
||||
Simply add `data-zoomable` to `<img>` tags that you want to make zoomable.
|
||||
|
||||
<div class="row mt-3">
|
||||
<div class="col-sm mt-3 mt-md-0">
|
||||
{% include figure.html path="assets/img/8.jpg" class="img-fluid rounded z-depth-1" zoomable=true %}
|
||||
</div>
|
||||
<div class="col-sm mt-3 mt-md-0">
|
||||
{% include figure.html path="assets/img/10.jpg" class="img-fluid rounded z-depth-1" zoomable=true %}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
The rest of the images in this post are all zoomable, arranged into different mini-galleries.
|
||||
|
||||
<div class="row mt-3">
|
||||
<div class="col-sm mt-3 mt-md-0">
|
||||
{% include figure.html path="assets/img/11.jpg" class="img-fluid rounded z-depth-1" zoomable=true %}
|
||||
</div>
|
||||
<div class="col-sm mt-3 mt-md-0">
|
||||
{% include figure.html path="assets/img/12.jpg" class="img-fluid rounded z-depth-1" zoomable=true %}
|
||||
</div>
|
||||
<div class="col-sm mt-3 mt-md-0">
|
||||
{% include figure.html path="assets/img/7.jpg" class="img-fluid rounded z-depth-1" zoomable=true %}
|
||||
</div>
|
||||
</div>
|
|
@ -1,41 +0,0 @@
|
|||
---
|
||||
layout: post
|
||||
title: a post with code
|
||||
date: 2015-07-15 15:09:00
|
||||
description: an example of a blog post with some code
|
||||
tags: formatting code
|
||||
categories: sample-posts
|
||||
---
|
||||
This theme implements a built-in Jekyll feature, the use of Rouge, for syntax highlighting.
|
||||
It supports more than 100 languages.
|
||||
This example is in C++.
|
||||
All you have to do is wrap your code in a liquid tag:
|
||||
|
||||
{% raw %}
|
||||
{% highlight c++ linenos %} <br/> code code code <br/> {% endhighlight %}
|
||||
{% endraw %}
|
||||
|
||||
The keyword `linenos` triggers display of line numbers.
|
||||
Produces something like this:
|
||||
|
||||
{% highlight c++ linenos %}
|
||||
|
||||
int main(int argc, char const \*argv[])
|
||||
{
|
||||
string myString;
|
||||
|
||||
cout << "input a string: ";
|
||||
getline(cin, myString);
|
||||
int length = myString.length();
|
||||
|
||||
char charArray = new char * [length];
|
||||
|
||||
charArray = myString;
|
||||
for(int i = 0; i < length; ++i){
|
||||
cout << charArray[i] << " ";
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
{% endhighlight %}
|
|
@ -1,9 +0,0 @@
|
|||
---
|
||||
layout: post
|
||||
title: a post with comments
|
||||
date: 2015-10-20 11:59:00-0400
|
||||
description: an example of a blog post with comments
|
||||
comments: true
|
||||
categories: sample-posts external-services
|
||||
---
|
||||
This post shows how to add DISQUS comments.
|
|
@ -1,27 +0,0 @@
|
|||
---
|
||||
layout: post
|
||||
title: a post with math
|
||||
date: 2015-10-20 11:12:00-0400
|
||||
description: an example of a blog post with some math
|
||||
tags: formatting math
|
||||
categories: sample-posts
|
||||
---
|
||||
This theme supports rendering beautiful math in inline and display modes using [MathJax 3](https://www.mathjax.org/) engine. You just need to surround your math expression with `$$`, like `$$ E = mc^2 $$`. If you leave it inside a paragraph, it will produce an inline expression, just like $$ E = mc^2 $$.
|
||||
|
||||
To use display mode, again surround your expression with `$$` and place it as a separate paragraph. Here is an example:
|
||||
|
||||
$$
|
||||
\sum_{k=1}^\infty |\langle x, e_k \rangle|^2 \leq \|x\|^2
|
||||
$$
|
||||
|
||||
You can also use `\begin{equation}...\end{equation}` instead of `$$` for display mode math.
|
||||
MathJax will automatically number equations:
|
||||
|
||||
\begin{equation}
|
||||
\label{eq:cauchy-schwarz}
|
||||
\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
|
||||
\end{equation}
|
||||
|
||||
and by adding `\label{...}` inside the equation environment, we can now refer to the equation using `\eqref`.
|
||||
|
||||
Note that MathJax 3 is [a major re-write of MathJax](https://docs.mathjax.org/en/latest/upgrading/whats-new-3.0.html) that brought a significant improvement to the loading and rendering speed, which is now [on par with KaTeX](http://www.intmath.com/cg5/katex-mathjax-comparison.php).
|
|
@ -1,282 +0,0 @@
|
|||
---
|
||||
layout: distill
|
||||
title: a distill-style blog post
|
||||
description: an example of a distill-style blog post and main elements
|
||||
date: 2021-05-22
|
||||
|
||||
authors:
|
||||
- name: Albert Einstein
|
||||
url: "https://en.wikipedia.org/wiki/Albert_Einstein"
|
||||
affiliations:
|
||||
name: IAS, Princeton
|
||||
- name: Boris Podolsky
|
||||
url: "https://en.wikipedia.org/wiki/Boris_Podolsky"
|
||||
affiliations:
|
||||
name: IAS, Princeton
|
||||
- name: Nathan Rosen
|
||||
url: "https://en.wikipedia.org/wiki/Nathan_Rosen"
|
||||
affiliations:
|
||||
name: IAS, Princeton
|
||||
|
||||
bibliography: 2018-12-22-distill.bib
|
||||
|
||||
# Optionally, you can add a table of contents to your post.
|
||||
# NOTES:
|
||||
# - make sure that TOC names match the actual section names
|
||||
# for hyperlinks within the post to work correctly.
|
||||
# - we may want to automate TOC generation in the future using
|
||||
# jekyll-toc plugin (https://github.com/toshimaru/jekyll-toc).
|
||||
toc:
|
||||
- name: Equations
|
||||
# if a section has subsections, you can add them as follows:
|
||||
# subsections:
|
||||
# - name: Example Child Subsection 1
|
||||
# - name: Example Child Subsection 2
|
||||
- name: Citations
|
||||
- name: Footnotes
|
||||
- name: Code Blocks
|
||||
- name: Layouts
|
||||
- name: Other Typography?
|
||||
|
||||
# Below is an example of injecting additional post-specific styles.
|
||||
# If you use this post as a template, delete this _styles block.
|
||||
_styles: >
|
||||
.fake-img {
|
||||
background: #bbb;
|
||||
border: 1px solid rgba(0, 0, 0, 0.1);
|
||||
box-shadow: 0 0px 4px rgba(0, 0, 0, 0.1);
|
||||
margin-bottom: 12px;
|
||||
}
|
||||
.fake-img p {
|
||||
font-family: monospace;
|
||||
color: white;
|
||||
text-align: left;
|
||||
margin: 12px 0;
|
||||
text-align: center;
|
||||
font-size: 16px;
|
||||
}
|
||||
|
||||
---
|
||||
|
||||
**NOTE:**
|
||||
Citations, footnotes, and code blocks do not display correctly in the dark mode since distill does not support the dark mode by default.
|
||||
If you are interested in correctly adding dark mode support for distill, please open [a discussion](https://github.com/alshedivat/al-folio/discussions) and let us know.
|
||||
|
||||
|
||||
## Equations
|
||||
|
||||
This theme supports rendering beautiful math in inline and display modes using [MathJax 3](https://www.mathjax.org/) engine.
|
||||
You just need to surround your math expression with `$$`, like `$$ E = mc^2 $$`.
|
||||
If you leave it inside a paragraph, it will produce an inline expression, just like $$ E = mc^2 $$.
|
||||
|
||||
To use display mode, again surround your expression with `$$` and place it as a separate paragraph.
|
||||
Here is an example:
|
||||
|
||||
$$
|
||||
\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
|
||||
$$
|
||||
|
||||
Note that MathJax 3 is [a major re-write of MathJax](https://docs.mathjax.org/en/latest/upgrading/whats-new-3.0.html) that brought a significant improvement to the loading and rendering speed, which is now [on par with KaTeX](http://www.intmath.com/cg5/katex-mathjax-comparison.php).
|
||||
|
||||
|
||||
***
|
||||
|
||||
## Citations
|
||||
|
||||
Citations are then used in the article body with the `<d-cite>` tag.
|
||||
The key attribute is a reference to the id provided in the bibliography.
|
||||
The key attribute can take multiple ids, separated by commas.
|
||||
|
||||
The citation is presented inline like this: <d-cite key="gregor2015draw"></d-cite> (a number that displays more information on hover).
|
||||
If you have an appendix, a bibliography is automatically created and populated in it.
|
||||
|
||||
Distill chose a numerical inline citation style to improve readability of citation dense articles and because many of the benefits of longer citations are obviated by displaying more information on hover.
|
||||
However, we consider it good style to mention author last names if you discuss something at length and it fits into the flow well — the authors are human and it’s nice for them to have the community associate them with their work.
|
||||
|
||||
***
|
||||
|
||||
## Footnotes
|
||||
|
||||
Just wrap the text you would like to show up in a footnote in a `<d-footnote>` tag.
|
||||
The number of the footnote will be automatically generated.<d-footnote>This will become a hoverable footnote.</d-footnote>
|
||||
|
||||
***
|
||||
|
||||
## Code Blocks
|
||||
|
||||
Syntax highlighting is provided within `<d-code>` tags.
|
||||
An example of inline code snippets: `<d-code language="html">let x = 10;</d-code>`.
|
||||
For larger blocks of code, add a `block` attribute:
|
||||
|
||||
<d-code block language="javascript">
|
||||
var x = 25;
|
||||
function(x) {
|
||||
return x * x;
|
||||
}
|
||||
</d-code>
|
||||
|
||||
**Note:** `<d-code>` blocks do not look well in the dark mode.
|
||||
You can always use the default code-highlight using the `highlight` liquid tag:
|
||||
|
||||
{% highlight javascript %}
|
||||
var x = 25;
|
||||
function(x) {
|
||||
return x * x;
|
||||
}
|
||||
{% endhighlight %}
|
||||
|
||||
***
|
||||
|
||||
## Layouts
|
||||
|
||||
The main text column is referred to as the body.
|
||||
It is the assumed layout of any direct descendants of the `d-article` element.
|
||||
|
||||
<div class="fake-img l-body">
|
||||
<p>.l-body</p>
|
||||
</div>
|
||||
|
||||
For images you want to display a little larger, try `.l-page`:
|
||||
|
||||
<div class="fake-img l-page">
|
||||
<p>.l-page</p>
|
||||
</div>
|
||||
|
||||
All of these have an outset variant if you want to poke out from the body text a little bit.
|
||||
For instance:
|
||||
|
||||
<div class="fake-img l-body-outset">
|
||||
<p>.l-body-outset</p>
|
||||
</div>
|
||||
|
||||
<div class="fake-img l-page-outset">
|
||||
<p>.l-page-outset</p>
|
||||
</div>
|
||||
|
||||
Occasionally you’ll want to use the full browser width.
|
||||
For this, use `.l-screen`.
|
||||
You can also inset the element a little from the edge of the browser by using the inset variant.
|
||||
|
||||
<div class="fake-img l-screen">
|
||||
<p>.l-screen</p>
|
||||
</div>
|
||||
<div class="fake-img l-screen-inset">
|
||||
<p>.l-screen-inset</p>
|
||||
</div>
|
||||
|
||||
The final layout is for marginalia, asides, and footnotes.
|
||||
It does not interrupt the normal flow of `.l-body` sized text except on mobile screen sizes.
|
||||
|
||||
<div class="fake-img l-gutter">
|
||||
<p>.l-gutter</p>
|
||||
</div>
|
||||
|
||||
***
|
||||
|
||||
## Other Typography?
|
||||
|
||||
Emphasis, aka italics, with *asterisks* (`*asterisks*`) or _underscores_ (`_underscores_`).
|
||||
|
||||
Strong emphasis, aka bold, with **asterisks** or __underscores__.
|
||||
|
||||
Combined emphasis with **asterisks and _underscores_**.
|
||||
|
||||
Strikethrough uses two tildes. ~~Scratch this.~~
|
||||
|
||||
1. First ordered list item
|
||||
2. Another item
|
||||
⋅⋅* Unordered sub-list.
|
||||
1. Actual numbers don't matter, just that it's a number
|
||||
⋅⋅1. Ordered sub-list
|
||||
4. And another item.
|
||||
|
||||
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
|
||||
|
||||
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
|
||||
⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅
|
||||
⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
|
||||
|
||||
* Unordered list can use asterisks
|
||||
- Or minuses
|
||||
+ Or pluses
|
||||
|
||||
[I'm an inline-style link](https://www.google.com)
|
||||
|
||||
[I'm an inline-style link with title](https://www.google.com "Google's Homepage")
|
||||
|
||||
[I'm a reference-style link][Arbitrary case-insensitive reference text]
|
||||
|
||||
[I'm a relative reference to a repository file](../blob/master/LICENSE)
|
||||
|
||||
[You can use numbers for reference-style link definitions][1]
|
||||
|
||||
Or leave it empty and use the [link text itself].
|
||||
|
||||
URLs and URLs in angle brackets will automatically get turned into links.
|
||||
http://www.example.com or <http://www.example.com> and sometimes
|
||||
example.com (but not on Github, for example).
|
||||
|
||||
Some text to show that the reference links can follow later.
|
||||
|
||||
[arbitrary case-insensitive reference text]: https://www.mozilla.org
|
||||
[1]: http://slashdot.org
|
||||
[link text itself]: http://www.reddit.com
|
||||
|
||||
Here's our logo (hover to see the title text):
|
||||
|
||||
Inline-style:
|
||||

|
||||
|
||||
Reference-style:
|
||||
![alt text][logo]
|
||||
|
||||
[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 2"
|
||||
|
||||
Inline `code` has `back-ticks around` it.
|
||||
|
||||
```javascript
|
||||
var s = "JavaScript syntax highlighting";
|
||||
alert(s);
|
||||
```
|
||||
|
||||
```python
|
||||
s = "Python syntax highlighting"
|
||||
print s
|
||||
```
|
||||
|
||||
```
|
||||
No language indicated, so no syntax highlighting.
|
||||
But let's throw in a <b>tag</b>.
|
||||
```
|
||||
|
||||
Colons can be used to align columns.
|
||||
|
||||
| Tables | Are | Cool |
|
||||
| ------------- |:-------------:| -----:|
|
||||
| col 3 is | right-aligned | $1600 |
|
||||
| col 2 is | centered | $12 |
|
||||
| zebra stripes | are neat | $1 |
|
||||
|
||||
There must be at least 3 dashes separating each header cell.
|
||||
The outer pipes (|) are optional, and you don't need to make the
|
||||
raw Markdown line up prettily. You can also use inline Markdown.
|
||||
|
||||
Markdown | Less | Pretty
|
||||
--- | --- | ---
|
||||
*Still* | `renders` | **nicely**
|
||||
1 | 2 | 3
|
||||
|
||||
> Blockquotes are very handy in email to emulate reply text.
|
||||
> This line is part of the same quote.
|
||||
|
||||
Quote break.
|
||||
|
||||
> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.
|
||||
|
||||
|
||||
Here's a line for us to start with.
|
||||
|
||||
This line is separated from the one above by two newlines, so it will be a *separate paragraph*.
|
||||
|
||||
This line is also a separate paragraph, but...
|
||||
This line is only separated by a single newline, so it's a separate line in the *same paragraph*.
|
|
@ -1,35 +0,0 @@
|
|||
---
|
||||
layout: post
|
||||
title: a post with github metadata
|
||||
date: 2020-09-28 21:01:00
|
||||
description: a quick run down on accessing github metadata.
|
||||
categories: sample-posts external-services
|
||||
---
|
||||
|
||||
A sample blog page that demonstrates the accessing of github meta data.
|
||||
|
||||
## What does Github-MetaData do?
|
||||
* Propagates the site.github namespace with repository metadata
|
||||
* Setting site variables :
|
||||
* site.title
|
||||
* site.description
|
||||
* site.url
|
||||
* site.baseurl
|
||||
* Accessing the metadata - duh.
|
||||
* Generating edittable links.
|
||||
|
||||
## Additional Reading
|
||||
* If you're recieving incorrect/missing data, you may need to perform a Github API<a href="https://github.com/jekyll/github-metadata/blob/master/docs/authentication.md"> authentication</a>.
|
||||
* Go through this <a href="https://jekyll.github.io/github-metadata/">README</a> for more details on the topic.
|
||||
* <a href= "https://github.com/jekyll/github-metadata/blob/master/docs/site.github.md">This page</a> highlights all the feilds you can access with github-metadata.
|
||||
<br />
|
||||
|
||||
## Example MetaData
|
||||
* Host Name : {{ site.github.hostname }}
|
||||
* URL : {{ site.github.url }}
|
||||
* BaseURL : {{ site.github.baseurl }}
|
||||
* Archived : {{ site.github.archived}}
|
||||
* Contributors :
|
||||
{% for contributor in site.github.contributors %}
|
||||
* {{ contributor.login }}
|
||||
{% endfor %}
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
layout: post
|
||||
title: a post with twitter
|
||||
date: 2020-09-28 11:12:00-0400
|
||||
description: an example of a blog post with twitter
|
||||
tags: formatting
|
||||
categories: sample-posts external-services
|
||||
---
|
||||
A sample blog page that demonstrates the inclusion of Tweets/Timelines/etc.
|
||||
|
||||
# Tweet
|
||||
An example of displaying a tweet:
|
||||
{% twitter https://twitter.com/rubygems/status/518821243320287232 %}
|
||||
|
||||
# Timeline
|
||||
An example of pulling from a timeline:
|
||||
{% twitter https://twitter.com/jekyllrb maxwidth=500 limit=3 %}
|
||||
|
||||
# Additional Details
|
||||
For more details on using the plugin visit: [jekyll-twitter-plugin](https://github.com/rob-murray/jekyll-twitter-plugin)
|
|
@ -1,43 +0,0 @@
|
|||
---
|
||||
layout: post
|
||||
title: a post with diagrams
|
||||
date: 2021-07-04 17:39:00
|
||||
description: an example of a blog post with diagrams
|
||||
---
|
||||
|
||||
This theme supports generating various diagrams from a text description using [jekyll-diagrams](https://github.com/zhustec/jekyll-diagrams){:target="\_blank"} plugin.
|
||||
Below, we generate a few examples of such diagrams using languages such as [mermaid](https://mermaid-js.github.io/mermaid/){:target="\_blank"}, [plantuml](https://plantuml.com/){:target="\_blank"}, [vega-lite](https://vega.github.io/vega-lite/){:target="\_blank"}, etc.
|
||||
|
||||
**Note:** different diagram-generation packages require external dependencies to be installed on your machine.
|
||||
Also, be mindful of that because of diagram generation the fist time you build your Jekyll website after adding new diagrams will be SLOW.
|
||||
For any other details, please refer to [jekyll-diagrams](https://github.com/zhustec/jekyll-diagrams){:target="\_blank"} README.
|
||||
|
||||
|
||||
## Mermaid
|
||||
|
||||
Install mermaid using `node.js` package manager `npm` by running the following command:
|
||||
```bash
|
||||
npm install -g mermaid.cli
|
||||
```
|
||||
|
||||
The diagram below was generated by the following code:
|
||||
|
||||
{% raw %}
|
||||
```
|
||||
{% mermaid %}
|
||||
sequenceDiagram
|
||||
participant John
|
||||
participant Alice
|
||||
Alice->>John: Hello John, how are you?
|
||||
John-->>Alice: Great!
|
||||
{% endmermaid %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
{% mermaid %}
|
||||
sequenceDiagram
|
||||
participant John
|
||||
participant Alice
|
||||
Alice->>John: Hello John, how are you?
|
||||
John-->>Alice: Great!
|
||||
{% endmermaid %}
|
Loading…
Reference in New Issue