Skip to content

Instantly share code, notes, and snippets.

View dmonad's full-sized avatar

Kevin Jahns dmonad

View GitHub Profile
@ifiokjr
ifiokjr / documentation-notes.md
Last active January 27, 2021 03:52
Remirror Documentation

Documentation

I find writing documentation difficult. Inline docs while I'm coding is fine, but sitting down and actually writing something that people can use to understand the codebase is very taxing for me.

These are notes to help guide me and hopefully make the process less taxing. Some parts will be copied and pasted directly in the remirror documentation site and other parts are observations and ideas.

Goals

I know what good documentation makes me feel like. It makes me feel safe and loved. It makes me trust the library I'm learning. Sometimes if the documentation is good enough it get's me excited. I may have come to the project to solve a specific problem but the docs are so good that now I want to share all about it.

@nitaku
nitaku / README.md
Last active July 22, 2020 19:55
Freehand drawing

A simple freehand drawing application, based on Bostock's Line Drawing gist.

Use your stylus, fingers or mouse to draw. The color of the line can be changed by interacting with the color palette, and the canvas can be cleared by clicking the trash in the upper-right corner of the UI.

The application uses two stacked SVG elements, one for the UI and one for the canvas. This is used to disable drawing when interacting with UI elements.

Unlike Bostock's example, this application maintains a DOM-independent object to store all the drawing's data (just look at the JavaScript console each time you complete a line).

Colors are from Colorbrewer's Dark2 palette.