From 0abcd6495d6d0db86873d287cf0c52b2088b15f9 Mon Sep 17 00:00:00 2001 From: BuildingAtom <84liadam@gmail.com> Date: Sat, 17 Jun 2023 15:11:51 -0400 Subject: [PATCH] Push theme version, update examples to fix justification, add some more to the overall example and documentation. --- README.md | 6 ++++++ _config.yml | 8 +++++++- index.markdown | 31 ++++++++++++++++++++++++++----- sel_map.markdown | 3 +++ 4 files changed, 42 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d2ac236..5f3377e 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ Besides, it makes it more difficult to get running as a project page anyway! All you should do is download the archive for one of the example branches (where you're reading this from right now!) and upload these files. These examples are close to the minimal files needed. +If you are planning to use this to make an organization specific template, then forking is reasonable. +Just make sure to change the `remote_theme` key inside of `_config.yml` to match your organization's setup. +More information on that can be found at the [jekyll-remote-theme repo](https://github.com/benbalter/jekyll-remote-theme). + ## Create an orphan branch and ensure that it is clean You'll want to keep your website code separate from the history of your actual project. @@ -94,6 +98,8 @@ Each of these should be self-explanatory, but change these to change the appeara **Note**: In addition to `css/stylesheet.scss`, you can make your own `css/overrides.css` or `css/overrides.scss` file. If it exists, this file is imported after `css/stylesheeet.scss` and can be used to override some of the style I have written. +If you wish to add plugins, check [GitHub Pages Dependency Versions](https://pages.github.com/versions/) to make sure your desired plugin is supported! + --- At this point, you have all the most basic initial configuration down! diff --git a/_config.yml b/_config.yml index ad71dc8..b6630d5 100644 --- a/_config.yml +++ b/_config.yml @@ -9,7 +9,7 @@ plugins: # Make sure GitHub supports them here: https://pages.github.com/versions/ # Don't change! (or do change if you really want ig) -remote_theme: BuildingAtom/project-pages@v1.1 +remote_theme: BuildingAtom/project-pages@v1.2-theme # Metadata and SEO-helper stuff # This title here should correspond to your base site or as a shared title @@ -18,6 +18,7 @@ baseurl: "/project-pages" # the subpath of your site, e.g. /blog url: "https://buildingatom.io" # the base hostname & protocol for your site, e.g. http://example.com # This sets window title, not the title you read on the page title-format: page-site # options are page-site, page, site. +lang: en # Shenanigans from the template default because that's actually not a thing. credit: @@ -31,12 +32,17 @@ show-credit: true # Disable the footer by just setting the above false AND making the below blank footer: + connections-pre: # This prefixes the connections section at the botom. connections-post: Socials connections: twitter: https://www.twitter.com/BuildingAtom github: https://github.com/BuildingAtom related-sites: sites: + - text: Base Example + href: /project-pages/ + icon: bi-box-arrow-left + icon-library: bootstrap-icons - text: SEL Map Example href: /project-pages/sel_map icon: bi-map diff --git a/index.markdown b/index.markdown index 9ec8cd1..bd283b2 100644 --- a/index.markdown +++ b/index.markdown @@ -6,7 +6,12 @@ date: 2023-06-16 03:03:01 -0400 description: >- # Supports markdown This is the main project page and the page used to demonstrate how this works with all of the options for the Front Matter present show-description: true + +# Add page-specifi mathjax functionality. Manage global setting in _config.yml mathjax: true +# Automatically add permalinks to all headings +# https://github.com/allejo/jekyll-anchor-headings +autoanchor: true # Preview image for social media cards image: @@ -45,6 +50,14 @@ links: icon-library: simpleicons text: Arxiv HP url: https://arxiv.org/ + - icon: bi-map + icon-library: bootstrap-icons + text: SEL_Map Ex. + url: /project-pages/sel_map + - icon: bi-bezier2 + icon-library: bootstrap-icons + text: ARMOUR Ex. + url: /project-pages/armour-dev - icon: github icon-library: simpleicons text: Code @@ -73,17 +86,19 @@ Let's try flipping the order. There is quite a bit of flexibility to how you structure the text too. Here, I'm going to make a justified grey content block with the heading outside. -# Content +# [Content](#content)
some text + +Try clicking this heading, this shows the manually defined header anchor, but if you do this, you should do it for all headings.
I made this look right by adding the `no-pre` class. If you don't include `markdown="1"` it will fail to render any markdown inside. -You can also make fullwidth embeds +You can also make fullwidth embeds (this doesn't actually link to any video)
- +
@@ -158,11 +173,17 @@ $$ \end{align*} $$ - You can also treat a section of text as a block, and use kramdown's block attribution methods to change fonts. You can see at the end of this section in the markdown that I do just that {: class="cabin"} +
+# This is a really long heading block so I can see if justify breaks the heading, and make sure that headings don't get justify unless they are explicitly classed with justify like the following heading + +# This is the following really long heading block so I can see if justify breaks the heading, and make sure that only this heading is justified because it has the explicit tag +{: class="justify"} +
+
# Citation @@ -179,4 +200,4 @@ You can see at the end of this section in the markdown that I do just that pages = "286--295" } ``` -
\ No newline at end of file +
diff --git a/sel_map.markdown b/sel_map.markdown index b44fc03..835f3d4 100644 --- a/sel_map.markdown +++ b/sel_map.markdown @@ -79,6 +79,7 @@ Here is a flow diagram illustrating out method. RGB-D images are semantically segmented using an off-the-shelf semantic segmentation network. Using the camera’s estimated pose and associated depth image, the pixel-wise probabilistic terrain class estimates are projected into the map. The height map is updated using a 1D Kalman filter and the terrain class estimates, alongside our novel material property dataset, are used to recursively estimate terrain properties for each region of the map. +{: class="justify"} ![A flow diagram of our method showing how color and depth images are integrated with a semantic segmentation network and material property database to perform bayesian interencing on a 2.5D elevation map.](https://roahmlab.github.io/sel_map/web_elements/flow_diagram.png "Flow Diagram of Method") @@ -87,6 +88,7 @@ The height map is updated using a 1D Kalman filter and the terrain class estimat We ran our method on the Spot quadruped using an on-board Realsense D435 RGB-D camera. Experiments were conducted both indoors and outdoors with a variety of terrain classes. We compared our method to a state-of-the-art traversability mapping framework to demonstrate the utility of our semantic mapping algorithm when compared to a traversability estimation algorithm. +{: class="justify"} ![Generated heightmaps and friction data for a variety of scenarios using our method.](https://roahmlab.github.io/sel_map/web_elements/comparison_full.PNG "Results Figure") @@ -94,6 +96,7 @@ Each column depicts the performance of our proposed mapping algorithm (second ro Traversability estimation sometimes believes that a region is traversable when it is not, such as an icy surface (column a) or a puddle (column e). In other scenarios, it believes that an area is intraversable when it is traversable such as on hills (column b, d) and near low vegetation (column c). Our method makes no claims about traversability, instead it estimates the probability distribution of terrain properties for each mesh element along with the terrain geometry. +{: class="justify"}
# Citation