Code Monkey home page Code Monkey logo

agrski.github.io's Introduction

agrski.github.io

Software for the sedentary: ML Ops, musings, more

agrski.github.io's People

Contributors

agrski avatar

Watchers

Gurminder Sunner avatar Clive Cox avatar  avatar

agrski.github.io's Issues

Add list of posts to index/landing page

The landing page/index for the site does not currently include any posts (specifically the dummy post that exists at the time of writing). This is due to the default layout, which does not account for posts or any included user-defined content.

This should be changed to incorporate a list of the existing posts.

Add Makefile recipe for generating PNGs from Mermaid diagrams

It's easy to forget to generate (up to date) diagrams from Mermaid definitions, especially when there are multiple diagrams per post. This is complicated by the process of adding copyright notices to the generated diagrams using an additional process, as Mermaid does not (yet) support adding captions to all its diagrams formats.

Writing a Makefile recipe would automate this process by capturing the required steps and, if written appropriately, would ensure all diagrams which are out of date relative to their definitions are automatically regenerated when the recipe is run.

In turn, this would support a GitHub Action to detect (or even automatically fix) the issue of stale images for diagrams. This additional functionality would be deferred to another issue, but is mentioned for completeness of context and motivation.

Add support for/display of tags

Tags should be displayed both on post pages for post-specific tags and also as a full list on the index page.

This is a continuation from #21.

Refactor post layout to be based on default layout

Currently there are two separate layouts for posts and other pages. However, these layouts are very similar, with the only base-level difference being that posts do not include the site's description/tag-line. Whilst I like the cleaner look of this for posts, as it removes a little bit of visual noise in a context wherein there is plenty else to focus on, it does mean keeping two highly duplicative layouts. Furthermore, it is not immediately obvious that these layouts have a lot in common.

At this stage it is not a significant concern either way, so it seems slightly easier to maintain if the post layout is explicitly based upon the default one.

Add page layout for posts

A post layout may wish to remove the tag-line/blog description, for example, in order to have a cleaner, more legible style. It may also be sensible to have the post title, date, any tags, and any author(s) defined at the top.

Implementing this will require defining a new Jekyll layout under docs/_layouts. To this end, it may be desirable to refactor the default layout and have separate page and post layouts that handle the header section and other such information differently.

Add Makefile recipe for templating Mermaid diagrams

Things like adding a title in the front matter, defining a top-to-bottom flowchart, and adding the same styling for focus, supporting, and consuming systems is standard boilerplate which is tedious to have to copy/paste.

Instead, a Makefile recipe which accepts a file name would make this more convenient.

Add introduction to blog landing page

The blog should have a landing page that provides an overview of the (sorts of) content. It may also wish to provide a brief explanation of the blog name.

Link back to home page should change colour on hover

Currently the blog/site title does not change its appearance on hover, with the only visual indication it can be clicked coming from the change in cursor type. Changing colour would provide an additional visual indication of how to navigate the site.

Fix attribution footer to use same style as in title/header "credits"

By separating the credits/attribution from the header section, it has lost the styling from the original theme.

Compare the current state:
image
with that of the original theme:
image

This seems to be due to the SCSS rules defining credits only for the #title ID, rather than for a general .credits class within a section. See here.

The solution is likely to be overriding/extending the SCSS rules.

Add tables of contents to post pages

For longer posts, this provides a convenient means of not only navigation, but also quickly assessing content.

I'm not sure if Jekyll has an in-built way of listing page headings, but hopefully there is some reasonable way of approaching this without delving into plug-ins.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.