Giter VIP home page Giter VIP logo

bic's Introduction

Howdy, Iโ€™m Paul ๐Ÿ‘‹

I hail from Minneapolis, MN. Land of road salt and a regional burger dubbed โ€œJucy Lucy.โ€ ๐Ÿ”

  • ๐Ÿ’ฌ Ask me about bikes, coffee, and Oxford commas.
  • ๐Ÿ“ซ How to reach me: [email protected]
  • ๐Ÿ˜„ Pronouns: he/him/his
  • โšก Fun fact: I can (& do) drive a manual. It's less impressive outside the USA.

bic's People

Contributors

mfossen avatar pinjasaur avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

mfossen

bic's Issues

Dynamic latest release version in docs

Would be nice to add the latest release version at the top, near the title/logo.

This could also be used to replace the latest Docker tag in the docker pull command. Just a bit of progressive enhancement.

A brief search shows the GitHub API should be able to get this information relatively trivially. Unsure if there's complications due to needing an API token and secrets don't exist on the frontend. https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#get-the-latest-release

ENV_VAR support

@mfossen pinged with on this out-of-band: it appears that ENV_VAR=value bic . type usage is not working. Using .env to define env vars still works, and I don't recall testing passing in env vars the typical way, but I agree it probably should work. Need to investigate & reproduce.

Tag support

A major feature that would be worth considering support for would be arbitrary tags to help categorize posts.

High level scope:

  • Determine the syntax to be used within the markdown document i.e. tags: tag1, tag2, tag3
  • What URL structure for the index of tags along with all the documents tagged something i.e. /tags and either /tags/{tag} or /tagged/{tag}
  • Roughly how the data structure would look internally to track tags to their source documents. Will certainly be janky because Bash doesn't make that trivial.

An initial proposal of a hypothetical markdown document:

# My title
tags: foo, bar, baz

Here are some words.

Lorem ipsum.

I'm partial to /tags and /tags/{tag} since it's more of a RESTful syntax.

Open questions:

  • How to parse tags?
    • Split on commas, trim whitespace? Do we trim all whitespace? And lowercase?

Archives page

Related to #12, if pagination is implemented and enabled then having an e.g. /archives.html page could be useful to enumerate over every single post.

Would need to consider what the template would look like and the data structure that supports it. Likely something like an all_entries key.

Pagination

Related to #10.

Supporting pagination would be a nice feature.

Some thoughts:

  • PER_PAGE as a envar config, default perhaps 10 and can scale indefinitely high for "no pagination"?
  • /page/{page} vs /pages/{page}?
  • Does the first page simply get mv-ed to index.html?

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.