Code Monkey home page Code Monkey logo

enginehou.se's People

Contributors

markbirbeck avatar

Watchers

 avatar  avatar

enginehou.se's Issues

add Netlify status badge to README

Description

Netlify provide a status badge which gives feedback on the latest build and deployment. It would be useful to add it to the README.

โœ… Tasks

  • add the status badge markdown to the README file

๐Ÿ Acceptance Criteria

  • the Netlify status badge is visible in the README

move test page to index.html

Description

The test page shows everything is working, but gives a 404 error when deployed:

Screenshot 2022-02-13 at 14 47 08

Although we can navigate to the example.html page, we might as well rename the markdown file to index.md, and then when deployed to index.html we only need to navigate to the root.

โœ… Tasks

  • rename example.md to index.md
  • update build tasks to use index.* instead of example.*

๐Ÿ Acceptance Criteria

  • the test page is available at the root of the site

add Material Design

Description

We need some colour. Let's first add Material Design, and then in a later ticket we'll add some theming.

โœ… Tasks

  • add JS Material Design entry
  • add CSS Material Design entry

๐Ÿ Acceptance Criteria

  • the site is generated correctly

๐Ÿ““ Notes

Add any additional notes, related links, etc.

add live reloading of generated site

Description

Whilst writing posts it would be good to be able to preview them. One option is to create a simple server that uses livereload.

โœ… Tasks

  • add livereload module
  • add livereload script tag to HTML output
  • add livereload command to the makefile

๐Ÿ Acceptance Criteria

  • the index page can be previewed and will refresh in the browser when build is run

use unified-args to provide CLI interface

Description

The current version of the CLI is simply a remark processor invoked with a single file from stdin and output is written to stdout. The unified family of modules provides a way to parse CLI input and run the remark processor, so we should use that.

โœ… Tasks

  • add unified-args module for CLI processing
  • change makefile entry to use CLI instead of stdinandstdout`
  • use unified CLI syntax instead of stdin and stdout

๐Ÿ Acceptance Criteria

  • the site is generated using the unified CLI

๐Ÿ““ Notes

Add any additional notes, related links, etc.

add Netlify deployment steps

Description

To publish the site we can use Netlify. This will involve placing generated HTML into a directory that Netlify can publish from.

โœ… Tasks

  • add output directory and hide from Git
  • add NPM build instruction to create HTML output
  • check Netlify config to publish

๐Ÿ Acceptance Criteria

  • the example page is published to a Netlfy site

add unified

Description

Need a way to add markdown posts. Got fed up with all the overhead of NextJS, Gatsby, Jekyll and so on. They are all great tools, especially for building applications. But seem to be over-engineered for blogging.

โœ… Tasks

  • add unified modules
  • add extra plugins, such as slug, TOC, document wrapper and formatting

๐Ÿ Acceptance Criteria

  • a simple example file can be output to stdout

add more meaningful content to index page

Description

The test page can now be turned into a 'proper' page, with some content about the purpose of the blog.

โœ… Tasks

  • add content to describe the purpose of the blog

๐Ÿ Acceptance Criteria

  • the index page has content which describes the purpose of the blog

factor processor to own module

Description

The processor is currently in the main index.js file. We should move it to its own file, and then it could be used for other things, we could have multiple processors, etc.

โœ… Tasks

  • factor the processor to its own module

๐Ÿ Acceptance Criteria

  • the site is still published correctly

๐Ÿ““ Notes

Add any additional notes, related links, etc.

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.