Shoora / tldrdevnotes.com

TL;DR Dev Notes

TLDR Dev Notes

Current State

In it's current state the site/project serves as my diary for all web development, system administration and web design notes. There may be some personal posts, but they are not meant to be public.

The site was originally built using Jekyll, but Jekyll turned into a slow hell when the posts turned into hundreds and the build times turned to 5-10mins. Hugo came to the rescue, super fast build times. But switching meant learning another syntax and setup, which slowed down the launch time. In the meantime, i kept adding notes, but they didn't show up online because the new site was never launched. Up until now.

Gatsby is another site generator that might be the next step for TLDRDevNotes.com

Theme

The theme used is built from scratch, following this nice Youtube series by Giraffe Academy and reading online documentation.

The name of the theme being used is tldr and the path is ./themes/tldr

Static assets

• Images directory is ./static/img/
• Use /img/ before the file name when referencing the image in files.

Developing the site

brew install hugo
hugo server -D --disableFastRender # -D, --buildDrafts, include content marked as draft

TODO

• Transfer/import posts from Jekyll
• Convert the site to use Hugo
• Make the site look good
• add 'Edit on Github' link
• add Page/Post Titles
• add path to post meta to make it easeir to find the relevant file

Features

• Search
• Disqus comments

Design

• Use Prism.js for syntax highlighting
• Change dateFormat
• List all sections/notebooks/categories in the sidebar
• Add an Urdu layout
• add styles for block quotes and quotes
• add spacing to footer
• make the bullet point on home page lighter in color
• add left padding to the sidebar/website
• Update Prism.css styles (styles for <code> tags)
• make code wrap so it doesn't overflow off the page
• add fontawesome (or some other svg icons)

Performance

• Optimize images
• Compress and minify CSS/JS

SEO and Visibility

• Generate a sitemap
• robots.txt
• add default meta info

Changelog

Dec 25, 2018

• moved site from Bitbucket to Github
• added file path (this makes my life easier when i have to find the file inside a folder in order to edit it)
• added Edit on Github link (so if anyone wants to edit the page, it opens it up on Github)
• wrap code blocks using white-space: pre-wrap; in prism.css
• removed all tags from the sidebar, they were unnecessary
• updated copyright to CC BY-SA 4.0 and ownership

Jul 13, 2018

• added metadata to posts (Redux, ReactJS)
• Renamed files (removed dates)
• Fixed syntax highlighting (removed pygments {% highlight python %} code)
• Fixed code indentation
• Fixed minor typos
• Added new posts