View Code? Open in Web Editor
NEW
Notes on various topics
Home Page: https://jashburn8020.github.io/notes/
License: Creative Commons Zero v1.0 Universal
Ruby 0.07%
HTML 12.08%
SCSS 87.84%
notes's Introduction
This GitHub Pages site uses the Reverie theme.
This page describes the steps taken to create a clean site using this theme.
Use the Reverie template repo to create a new GitHub repo.
Select the "Actions" tab on GitHub to see the pages being built and deployed.
When deployed, go to https://
username
.github.io/notes/
to confirm the site has been built correctly, including its links.
Prerequisite: Ruby
Clone the repo.
Install gems:
Build and run the site:
Confirm the site is built correctly, including its links.
Remove sponsor buttons on the repo.
Remove .github/FUNDING.yml
.
Repo > Settings > General > uncheck "Sponsorships".
Update LICENSE .
Remove .ruby-version
.
Remove the default favicon images:
favicon.ico
images/favicon-32x32.png
Create your favicons, e.g., using https://favicon.io/favicon-generator/ .
Put the new favicons into images
.
Note: If the new favicons include a site.webmanifest
file, ensure the file's icon src
s point to the right location and update other details accordingly.
Update _layouts/default.html
to point to the new favicons.
Title, Header, and Footer
Select a font from Google Fonts and get the font's embed code.
Replace existing font stacks in _sass/_variables.scss
with a new font stack that includes the selected font.
Switch references to the existing font stack in assets/style.scss
to the new font stack.
Update font settings in assets/style.scss
.
Remove redundant (font) import at-rule.
Replace existing font-family
values with the new font stack.
Redundant and Other Unwanted Elements
Remove Carbon Ads and related resources:
_posts/2019-02-13-introducing-reverie-jekyll-theme.md
assets/style.scss
(search for "carbon")
Remove Google Analytics tracking code in _config.yml
.
Date format:
Header font weight:
Nav bar font weight:
Search result styles:
Default Pages, Posts, and Other Elements
404 page:
Remove image in 404.md
.
Delete corresponding image.
Getting Started page:
About page:
Fonts:
Delete fonts/aramisi.ttf
.
Delete fonts/EBGaramond-Regular.ttf
Posts:
Delete all posts under _posts
.
Images:
Delete default (unused) images:
images/categories.png
images/galaxy.jpg
images/mobile-demo.png
images/reverie-demo.png
images/reverie-text.png
images/search.png
Reintroduce the Categories page.
Add new posts to _posts
as .md
files.
Posts' front matter :
Use the post
layout: layout: post
.
Set the title
and categories
variables.
Post file name format: yyyy-mm-dd-title.md
Ability to display PlantUML diagrams on posts, where the diagrams' code is embedded directly in the posts and diagram images are generated on-the-fly.
Introduce custom plantuml
tags to be used in posts.
Add JavaScript code in _includes/plantuml.html
.
Convert custom plantuml
tags into standard HTML figure
, img
, and figcaption
tags.
JavaScript code is activated if the plantuml
page variable is true
on posts' front matter.
JavaScript code uses plantuml-encoder 's plantuml-encoder.min.js
to encode diagram code to be sent to PlantUML's SVG service .
Add the JavaScript code in the _layouts/post.html
layout: {% include plantuml.html %}
Update assets/style.scss
to style the image caption: img + figcaption
notes's People
Contributors
Watchers