📎 Webclip
Introducing Code Notes
The post says the author started making code notes because he kept searching for answers to problems he had already solved. He wanted notes with snippets, examples, explanations, and copied documentation, but none of the apps he tried had all the features he wanted.
Reading notes#
- Code Notes is a Gatsby theme that gives full control over how notes are written, published, and stored.
- The notes are searchable and shareable by default, so the author could send links to colleagues.
- GitHub hosts the notes, so they are versioned with Git and can be forked or reverted.
- Notes are written in MDX or markdown, and MDX lets JSX or HTML render inside the note.
- Notes can include interactive code and previews side by side.
- Iframes can also be added, including gists, Codepens, and Figma designs.
- Search includes all code snippets, using Flexsearch with optimizations for speed.
- The design is intentionally simple so notes stay legible, and there are light and dark themes.
- The notes also work well on mobile.
- A Gatsby starter is available for setting up a notes site.
- A first note can be created by adding an
.mdxfile in thenotesdirectory with frontmatter and content. - The project is open source, and the author invites feedback, contributions, and bug reports.
- The author says Notion worked well for about a year, but it was slow.
- SnippetsLab, Quiver, and Boostnote were fast and useful for code snippets, but notes were less accessible and had no preview.
