changed to submitting.md, and to example-content

_posts/2020-04-02-example-content.md

@@ -1,6 +1,6 @@
 ---
 layout: post
-title: Example content (Images and Assets)
+title: Example content (Images, Assets, HTML Figures, Latex)
 tags: [test, tutorial, markdown]
 authors: Doe, John, School of Life; Doe, Jane, A School
 ---
@@ -144,3 +144,69 @@ To add HTML figures, you must add them to the `_includes` folder. Again, add the
 Here, `\{\% include example_content_jdoe/plotly_demo_1.html \%\}` (without the `\` character before `}`, `{` and `%`) becomes
 
 {% include example_content_jdoe/plotly_demo_1.html %}
+
+
+
+## How to add $\LaTeX$ commands to your posts:
+
+### Inline
+
+To add inline math, you can use `$ <math> $`. Here is an example:
+
+
+`$ \sum_{i=0}^j \frac{1}{2^n} \times i $` becomes
+$ \sum_{i=0}^j \frac{1}{2^n} \times i $
+
+### Block
+
+To add block math, you *must* use `$$<math>$$`. Here are some examples:
+
+```
+$$\begin{equation}
+a \times b \times c = 0 \\
+j=1 \\
+k=2 \\
+\end{equation}$$
+```
+
+...becomes...
+
+$$\begin{equation}
+a \times b \times c = 0 \\
+j=1 \\
+k=2 \\
+\end{equation}$$
+
+```
+$$\begin{align}
+i2 \times b \times c =0 \\
+j=1 \\
+k=2 \\
+\end{align}$$
+```
+
+...becomes...
+
+$$\begin{align}
+i2 \times b \times c =0 \\
+j=1 \\
+k=2 \\
+\end{align}$$
+
+Don't forget the enclosing `$$`! Otherwise, your newlines won't work:
+
+```
+\begin{equation}
+i2=0 \\
+j=1 \\
+k=2 \\
+\end{equation}
+```
+
+...becomes...
+
+\begin{equation}
+i2=0 \\
+j=1 \\
+k=2 \\
+\end{equation}

submitting.md

@@ -8,7 +8,9 @@ The process is relatively simple.
 ## Overall process
 
 1. Download the lastest release of the template: https://github.com/iclr-blog-track/iclr-blog-track.github.io/releases/tag/v1.1.1
-2. Write your post by modifying the `_posts/2021-04-25-template.md` file that is in the branch **submission**. **This edited `MarkDown` file and the associated images/gifs must be your sole change to the entire blog.** You can use standard GitHub-flavoured MarkDown. Additionally, you have to edit the file's header:
+2. Write your post by modifying the `_posts/2021-04-25-template.md` file that is in the branch **submission**. **This
+    edited `MarkDown` file and the associated images/gifs/HTML figures must be your sole change to the entire blog.**
+    You can use standard GitHub-flavoured MarkDown. Additionally, you have to edit the file's header:
     ```
    ---
     layout: post
@@ -17,144 +19,53 @@ The process is relatively simple.
     authors: Doe, John, Mila; Doe, Jane, DeepMind
     ---
    ```
-    You must change the `title`, `tags`, and `authors` fields. The `authors` and `title` fields accept standard strings, but the `tags` field must be an array (i.e. a string starting with `[`, followed by a comma-separated list of tags, followed by `]`).
+    You must change the `title`, `tags`, and `authors` fields. The `authors` and `title` fields accept standard strings,
+    but the `tags` field must be an array (i.e. a string starting with `[`, followed by a comma-separated list of tags, followed by `]`).
 
-    Don't worry about using "new" tags. Our blog server will automatically adapt to new tag names without issue.
-
-    If you want to include gifs, images, and the like, you can add them to the `public/images` folder.
+    Don't worry about using new tags. Our blog server will automatically adapt to new tag names without issue.
 
     Read our example posts carefully to make sure that your embedded assets and $ \LaTeX $ work!
-3. Export a static version of your blobpost (see below for details about this step). Note that no javascript 
-4. Submit an anonymized version of your post to our OpenReview. To do so, simply remove any references to yourself from your MarkDown file, upload your static blogpost as a ZIP file, and send it to OpenReview. A link will be provided at a later date.
 
-    ![Download instructions image]({{ site.url }}/public/images/download_zip.png)
-    Include a README.txt file in the root of that ZIP that mentions which blog post is yours.
+    Read about rendering your post locally [bellow](#serving).
+3. To submit, anonymize your blog. To do so, simply remove any references to yourself from your MarkDown file.
+    Then, export a static version of your blog post. To do so, you can type `make zip` in a terminal open in your blog's directory.
+    This will package your blog into a `site.zip` file.
+    It will also export a `vars.yml` containing your submission ID.
 
-5. Upon acceptance, you will be contacted. You will then make a public fork of the official repository, and open a Pull Request to merge your changes with our repository. After asking you to fix any compatibility issues (or fixing them ourselves if they are minor enough), we will then merge your fork into the blog. That way, GitHub will keep track of every single change made to the blog (and if someone wants to find a posts' authors' GitHub usernames, they'll directly be able to find your Pull Request and your fork!).
+    **NOTE**: You will need to install Docker. Read about exporting your blog [bellow](#exporting).
+4. Upon acceptance, you will be contacted. You will then make a public fork of the official repository, and open a Pull
+    Request to merge your changes with our repository. After asking you to fix any compatibility issues
+    (or fixing them ourselves if they are minor enough), we will then merge your fork into the blog. That way,
+    GitHub will keep track of every single change made to the blog (and if someone wants to find a posts' authors'
+    GitHub usernames, they'll directly be able to find your Pull Request and your fork!).
 
+<a id="exporting"></a>
 ## Exporting a static version of your website
 
-### With Docker (recommended method)
-
-TBD 
-
-### With jerkyll
-
-
-#### Installation of Jerkyll (Ubuntu)
-
-1. Install Ruby (I'm using v3.2.5)
-
-```bash
-sudo apt install ruby-full
-```
-
-2. Once installed, add the following to your `.bashrc` or whatever terminal startup script you may use:
-
-```bash
-export GEM_HOME="$HOME/.gem"
-export PATH="$HOME/.gem/bin:$PATH"
-```
-
-3. Install bundler:
-
-```bash
-gem install jekyll bundler
-```
-
-4. Install dependencies:
-
-From within this repository's root directory, run:
-
-```bash
-bundle init
-```
-It creates a ```Gemfile``` file. Edit the file in order to have the following ```Gemfile```
-
-```
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# gem "rails"
-gem "jekyll-gist"
-gem "jekyll-sitemap"
-gem "jekyll-seo-tag" 
-gem "jekyll-paginate"
-gem "webrick"
-```
-Then run
+### With Docker
 
 ```bash
-bundle install
+make zip
 ```
 
-#### Installation of Jerkyll (MacOS and Windows)
-
-Mac and Windows users can find relevant guides for installing Jekyll here:
+### With jekyll (use at your own risk, not officially supported)
 
-- [Windows guide](https://jekyllrb.com/docs/installation/windows/)
-- [MacOS guide](https://jekyllrb.com/docs/installation/macos/)
+You can read commands used by our Docker image [here](https://github.com/iclr-blog-track/github-pages-docker).
 
-Additionally, you will need to do a few steps in Windows before serving you are able to serve your page locally. The steps below are Windows only, and you won't need them if you're on a Linux based machine. 
+You can read about Jekyll [here](https://github.com/udem-ift6758/blogpost-template).
 
-#### Windows Specific Steps:
 
-Before running these, you'd want to make sure your Ruby and Jekyll installations are functional.
+<a id="serving"></a>
+## Serving the Page Locally
 
-1. From within the repository's root directory, run: 
-
-```
-bundle add webrick
-```
-
-2. Open the `gemfile` present in the root directory of the repository, and add the following line at the end of the file: 
-
-```
-gem 'wdm', '>= 0.1.0'
-```
-
-3. Run the following command in the same directory: 
-
-```
-gem install wdm
-```
-
-You should be able to serve the page locally on Windows after these steps. 
-
-### Serving the Page Locally
-
-Once you've installed jekyll and all of the dependencies, you can now serve the webpage on your local machine for development purposes using the `jekyll serve` command, using bundle to handle any dependencies.
-In your terminal, from the directory containing the Jekyll project run:
+### With Docker
 
 ```bash
-bundle exec jekyll serve
-```
-
-You should see something along the lines of:
-
-```
-> bundle exec jekyll serve
-Configuration file: /home/USER/ift6758-blog-template/_config.yml
-            Source: /home/USER/ift6758-blog-template
-       Destination: /home/USER/ift6758-blog-template/_site
- Incremental build: disabled. Enable with --incremental
-      Generating... 
-                    done in 0.661 seconds.
- Auto-regeneration: enabled for '/home/USER/ift6758-blog-template'
-    Server address: http://127.0.0.1:4000/
-  Server running... press ctrl-c to stop.
+make serve
 ```
 
-If you see this, you've successfully served your web page locally!
-You can access it at server address specified, in this case `http://127.0.0.1:4000/`.
+### With jekyll (use at your own risk, not officially supported)
 
-### Generating the html file
-
-```bash
-JEKYLL_ENV=production bundle exec jekyll build
-```
+You can read commands used by our Docker image [here](https://github.com/iclr-blog-track/github-pages-docker).
 
-The static html webpage should appear in ```/_site```
+You can read about Jekyll [here](https://github.com/udem-ift6758/blogpost-template).