Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (7.4%) to scientific vocabulary
Keywords
Repository
My personal website
Basic Info
- Host: GitHub
- Owner: AppleGamer22
- License: gpl-3.0
- Language: Markdown
- Default Branch: master
- Homepage: https://applegamer22.github.io
- Size: 180 MB
Statistics
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
applegamer22.github.io
My personal website, built with Hugo and Congo.
Additions to Congo
I added some features because I'm not pleased with how Hugo's shortcode syntax prevents some content from being rendered correctly on external Markdown platforms such as GitHub and GitLab.
The conditional loading of KaTeX and Mermaid is possible because of the modified head.html partial template that calls to the extend-head.html partial template with global context (with {{partial "extend-head.html" $}}) instead of configuration file context (with {{partial "extend-head.html" .Site}}).
KaTeX
The following layouts/partials/extend-head.html code is based on this comment from the Congo Theme discussion board, and is also based on this file from Congo Theme's codebase.
html
{{if $.Params.math}}
{{$katexCSS := resources.Get "lib/katex/katex.min.css"}}
{{$katexCSS := $katexCSS | resources.Fingerprint "sha512"}}
<link type="text/css" rel="stylesheet" href="{{$katexCSS.RelPermalink}}" integrity="{{$katexCSS.Data.Integrity}}">
{{$katexJS := resources.Get "lib/katex/katex.min.js"}}
{{$katexJS := $katexJS | resources.Fingerprint "sha512"}}
<script defer src="{{$katexJS.RelPermalink}}" integrity="{{$katexJS.Data.Integrity}}"></script>
{{$katexRenderJS := resources.Get "lib/katex/auto-render.min.js"}}
{{$katexRenderJS := $katexRenderJS | resources.Fingerprint "sha512"}}
<script defer src="{{$katexRenderJS.RelPermalink}}" integrity="{{$katexRenderJS.Data.Integrity}}"></script>
{{$katexFonts := resources.Match "lib/katex/fonts/*"}}
{{range $katexFonts}}
<!-- {{.RelPermalink}} -->
{{end}}
<script>
document.addEventListener("DOMContentLoaded", () => {
for (const p of document.querySelectorAll("p")) {
if (/\$\$.*\$\$/g.test(p.innerText) && p.hasChildNodes()) {
for (const child of p.children) {
if (child.tagName === "EM") {
const textNode = document.createTextNode(`_${child.innerText}_`);
p.replaceChild(textNode, child);
}
}
}
}
renderMathInElement(document.body, {
delimiters: [
{
left: "$$",
right: "$$",
display: true
},
{
left: '$',
right: '$',
display: false
},
],
preProcess: math => math.replaceAll(" \\\n", " \\\\\n"),
throwOnError: false
});
});
</script>
{{end}}
This change makes the KaTeX CSS and JavaScript files to load by default, and it also enables the single $ delimiter to be used with less future configuration.
Due to Hugo's use of the \ character for text escaping, the preProcess^1 function is required in order to correctly render the $\TeX$ source code as it was intended to be rendered. Moreover, the align* environment seems to be the most compatible between KaTeX and MathJax.
Technical Diagrams
The following layouts/partials/extend-head.html code is based on Docsy's diagram support, and implemented similarly to Docsy's implementation, and Congo's implementation, the theme settings are based on Mermaid's documentation.
```html {{if .Params.diagrams}} {{$mermaidLib := resources.Get "lib/mermaid/mermaid.min.js"}} {{$mermaidConfig := resources.Get "js/mermaid.js"}} {{$mermaidConfig := $mermaidConfig | resources.Minify}} {{$mermaidJS := slice $mermaidLib $mermaidConfig | resources.Concat "js/mermaid.bundle.js" | resources.Fingerprint "sha512"}}
<script>
/**
* @type {string} color an RGB tuple that represents a colour in CSS
* @returns an RGB CSS function form of the variable
*/
function tuple2RGB(color) {
return `rgb(${getComputedStyle(document.documentElement).getPropertyValue(color)})`;
}
document.addEventListener("DOMContentLoaded", () => {
const diagrams = document.querySelectorAll("code.language-mermaid");
let hasDiagram = diagrams.length > 0;
if (!hasDiagram) return;
for (const diagram of diagrams) {
const text = diagram.textContent;
const pre = document.createElement("pre");
pre.classList.add("mermaid");
pre.textContent = text;
diagram.parentElement.replaceWith(pre);
}
for (const appearanceSwitcher of document.querySelectorAll("[id^='appearance-switcher']")) {
appearanceSwitcher.addEventListener("click", () => location.reload())
}
// window.matchMedia("(prefers-color-scheme: dark)").addEventListener("change", () => location.reload());
document.querySelector("button#appearance-switcher-0").addEventListener("click", () => location.reload());
});
</script>
{{end}} ```
The following CSS was added to assets/css/custom.css, in order to make the diagram's background colour transparent.
css
pre.mermaid {
background-color: transparent !important;
}
Changes to Congo
CSS
Horizontal Scrolling
The following CSS was added to assets/css/custom.css in order to disable horizontal scrolling.
- The single-line width of HTML
atags HTML tags is capped at the screen width. - Horizontal scroll is disabled on the HTML
bodyscope.
```css body { overflow-x: hidden; }
a { max-width: 100vw !important; word-wrap: break-word !important; } ```
In order to render multi-line math expressions correctly in small-width screens, the following CSS code was added to assets/css/custom.css:
css
@media (max-width: 640px) {
span.katex-display > * {
font-size: 0.65rem !important;
}
}
In order to ensure search results don't overflow the intended width, the maximum width is restricted accordingly with following CSS code was added to assets/css/custom.css:
```css
search-results > li > a > * {
max-width: calc(100% - 1.5rem) !important;
word-wrap: break-word !important;
} ```
In order to ensure that embedded YouTube videos stay withing the width of a mobile screen, the following CSS code was added to assets/css/custom.css:
css
iframe {
max-width: 100%;
}
Fixed-Width Font
The following CSS was added to assets/css/custom.css (based on this Stack Overflow comment) in order to set Fira Code/Cascadia Code (or the OS's default) as the fixed-width font, used in code snippets.
css
@font-face {
font-family: 'Fira Code';
src: local('FiraCode-Regular'), url('/FiraCode-Regular.ttf') format('truetype');
}
code {
font-family: 'Cascadia Code', 'Fira Code', monospace !important;
}
Backtick-less Inline Code Snippets
The following CSS was added to assets/css/custom.css in order to revert Congo Theme's main.css that surrounds inline code snippets with backtick symbols.
css
.prose :where(code):not(:where([class~="not-prose"] *))::before {
content: unset !important;
}
.prose :where(code):not(:where([class~="not-prose"] *))::after {
content: unset !important;
}
Quote-less Block Quote
The following CSS was added to assets/css/custom.css in order to revert Congo Theme's main.css that surrounds block quote with literal quotes.
```css .prose :where(blockquote p:first-of-type):not(:where([class~="not-prose"] *))::before { content: unset !important; }
.prose :where(blockquote p:last-of-type):not(:where([class~="not-prose"] *))::after { content: unset !important; } ```
Nested Unordered Lists
The following CSS was added to assets/css/custom.css in order to set the second nested unordered list item bullet style as a square instead of a circle
css
ul > li > ul {
list-style-type: square !important;
}
Content Width
The following CSS was added to assets/css/custom.css in order to increase the content width (based on Congo Theme's main.css):
css
.max-w-7xl {
max-width: 100rem !important;
}
.max-w-prose {
max-width: 100ch !important;
}
The following CSS was added to assets/css/custom.css in order to decrease the spacing between the menu items (based on Congo Theme's main.css):
css
@media(min-width: 640px) {
[dir="rtl"] .prose ol > li, [dir="ltr"] .ltr\:sm\:mr-7 {
margin-right: 0.75rem !important;
}
}
Colour Scheme
The following CSS was added to assets/css/schemes/fruit.css (based on Congo's congo.css and fire.css) change the colour scheme primary and secondary colours from violate-fuchsia to orange-red.
css
:root {
--color-neutral: 255, 255, 255;
/* Gray */
--color-neutral-50: 250, 250, 250;
--color-neutral-100: 244, 244, 245;
--color-neutral-200: 228, 228, 231;
--color-neutral-300: 212, 212, 216;
--color-neutral-400: 161, 161, 170;
--color-neutral-500: 113, 113, 122;
--color-neutral-600: 82, 82, 91;
--color-neutral-700: 63, 63, 70;
--color-neutral-800: 39, 39, 42;
--color-neutral-900: 24, 24, 27;
/* Orange */
--color-primary-50: 255, 247, 237;
--color-primary-100: 255, 237, 213;
--color-primary-200: 254, 215, 170;
--color-primary-300: 253, 186, 116;
--color-primary-400: 251, 146, 60;
--color-primary-500: 249, 115, 22;
--color-primary-600: 234, 88, 12;
--color-primary-700: 194, 65, 12;
--color-primary-800: 154, 52, 18;
--color-primary-900: 124, 45, 18;
/* Rose */
--color-secondary-50: 255, 241, 242;
--color-secondary-100: 255, 228, 230;
--color-secondary-200: 254, 205, 211;
--color-secondary-300: 253, 164, 175;
--color-secondary-400: 251, 113, 133;
--color-secondary-500: 244, 63, 94;
--color-secondary-600: 225, 29, 72;
--color-secondary-700: 190, 18, 60;
--color-secondary-800: 159, 18, 57;
--color-secondary-900: 136, 19, 55;
}
Menu Header
The following CSS was added to assets/css/custom.css in order to show/hide the desktop or mobile menu header based on the width of the screen:
```css @media (min-width: 700px) { #header-narrow { display: none !important; }
.header-wide {
display: block !important;
}
}
/* header for narrow screens */ @media (max-width: 700px) { #header-narrow { display: block !important; }
.header-wide {
display: none !important;
}
li#header-narrow > label > div > ul {
padding-top: 3rem !important;
}
} ```
The HTML was inspired by a combination of Congo Theme's basic and hamburger layouts. The HTML code is available at layouts/partials/header/custom.html.
Logo
- Export
logo.svgto a $500 \times 500$-pixels PNG, saved atassets/logo.png. - Use https://favicon.io/favicon-converter/ with
assets/logo.pngand save the output assets to thestaticdirectory.
Useful Links
Owner
- Name: Omri Bornstein
- Login: AppleGamer22
- Kind: user
- Location: Melbourne, Australia
- Website: https://applegamer22.github.io
- Repositories: 9
- Profile: https://github.com/AppleGamer22
Software Engineer, Gopher, TeXnician | Enthusiastic About Open-Source Software and Software Supply Chains
GitHub Events
Total
- Delete event: 43
- Issue comment event: 7
- Push event: 104
- Pull request event: 83
- Create event: 40
Last Year
- Delete event: 43
- Issue comment event: 7
- Push event: 104
- Pull request event: 83
- Create event: 40
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 1
- Total pull requests: 27
- Average time to close issues: 1 minute
- Average time to close pull requests: 35 minutes
- Total issue authors: 1
- Total pull request authors: 1
- Average comments per issue: 1.0
- Average comments per pull request: 0.33
- Merged pull requests: 22
- Bot issues: 1
- Bot pull requests: 27
Past Year
- Issues: 1
- Pull requests: 27
- Average time to close issues: 1 minute
- Average time to close pull requests: 35 minutes
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 1.0
- Average comments per pull request: 0.33
- Merged pull requests: 22
- Bot issues: 1
- Bot pull requests: 27
Top Authors
Issue Authors
Pull Request Authors
- dependabot[bot] (61)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v3 composite
- actions/dependency-review-action v3 composite
- caddy 2.6.3-alpine build
- golang 1.20.1-alpine build
- github.com/jpanther/congo/v2 v2.10.0
- github.com/jpanther/congo/v2 v2.10.0
- actions/cache v4 composite
- actions/checkout v4 composite
- peaceiris/actions-gh-pages v4 composite
- peaceiris/actions-hugo v3 composite