{"id":14235400,"url":"https://github.com/mmagnus/geekbook","last_synced_at":"2026-01-17T22:48:43.601Z","repository":{"id":14872744,"uuid":"68387128","full_name":"mmagnus/geekbook","owner":"mmagnus","description":"G33KB00K3 - fun to read \u0026 fun to write -- 🤓 eXtreme eXtendable note taking system for nerds/geeks (including scientists!) docs: http://geekbook.rtfd.io = beautiful html generator of your markdown-based notes","archived":false,"fork":false,"pushed_at":"2025-09-30T22:39:16.000Z","size":19213,"stargazers_count":44,"open_issues_count":24,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-10-01T00:23:50.403Z","etag":null,"topics":["emacs","emacs-powered","geek","labbook","nerds","note-taking","notes"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mmagnus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2016-09-16T14:33:36.000Z","updated_at":"2025-09-30T22:39:21.000Z","dependencies_parsed_at":"2023-01-11T20:22:38.478Z","dependency_job_id":"4b937a05-7f02-4485-9cf8-2bb6ad83e346","html_url":"https://github.com/mmagnus/geekbook","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/mmagnus/geekbook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmagnus%2Fgeekbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmagnus%2Fgeekbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmagnus%2Fgeekbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmagnus%2Fgeekbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mmagnus","download_url":"https://codeload.github.com/mmagnus/geekbook/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmagnus%2Fgeekbook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28521166,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T22:11:28.393Z","status":"ssl_error","status_checked_at":"2026-01-17T22:11:27.841Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emacs","emacs-powered","geek","labbook","nerds","note-taking","notes"],"created_at":"2024-08-20T21:01:52.537Z","updated_at":"2026-01-17T22:48:43.586Z","avatar_url":"https://github.com/mmagnus.png","language":"Python","funding_links":["https://www.paypal.me/MarcinMagnus"],"categories":["Python"],"sub_categories":[],"readme":"# geekbook3 - note taking system for nerds!\n💥 Now in dark mode! 💥 \n![](docs/imgs/darkmode.jpg)\n\nMarcin Magnus (mmagnus) \u0026 Pietro Boccaletto (akaped)\n\n[![Twitter Follow](http://img.shields.io/twitter/follow/geekbookx.svg?style=social\u0026label=Follow)](https://twitter.com/geekbookx)\n[![tag](https://img.shields.io/github/release/mmagnus/geekbook.svg)](https://github.com/mmagnus/geekbook/releases)\n[![Build Status](https://travis-ci.org/mmagnus/geekbook.svg?branch=master)](https://travis-ci.org/mmagnus/geekbook)\n[![Documentation Status](https://readthedocs.org/projects/geekbook/badge/?version=latest)](http://geekbook.readthedocs.io/en/latest/?badge=latest)\n![http://www.gnu.org/licenses/gpl-3.0.html](http://img.shields.io/:license-gpl3-blue.svg)\n\u003cspan class=\"badge-paypal\"\u003e\u003ca href=\"https://www.paypal.me/MarcinMagnus\" title=\"Donate to this project using Paypal\"\u003e\u003cimg src=\"https://img.shields.io/badge/paypal-donate-yellow.svg\" alt=\"PayPal donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e \n\u003cspan class=\"badge-flattr\"\u003e\u003ca href=\"https://flattr.com/profile/mmagnus\" title=\"Donate to this project using Flattr\"\u003e\u003cimg src=\"https://img.shields.io/badge/flattr-donate-yellow.svg\" alt=\"Flattr donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003c/p\u003e\n\n\u003ci\u003eMotto: **Notes are like your code**.\u003c/i\u003e\n\n(geekbook3 since finally Geekbook uses Python 3)\n\nG33KB00K3 - fun to read \u0026 fun to write -- 🤓 eXtreme eXtendable note taking system for nerds (including scientists!) (= beautiful html generator of your markdown-based notes)  docs: http://geekbook.rtfd.io\n\n**THE LATEST**\n\n[Geekbook Bookify]( https://github.com/mmagnus/geekbook/tree/master/plugins/bookify) - a plugin to process your notes into e-books\n\n**MOTIVATION**\n\nI started using MoinMoin for my personal notes in 2008, but something was missing... I started then playing with simple notes in Markdown written in my Emacs. The next step was to write a system to convert these notes into HTML. The system was drafted in Gdańsk at the PTBI conference (2012) when I decided to write a tool to process a folder with notes written in Markdown. I wanted to use my CSS style and then more and more unique features that I found very useful for myself. I think, at the moment, the project converged pretty much to tools like static site generators http://jekyllrb.com, https://www.mkdocs.org, https://getpelican.com with some unique features developed by myself for myself ;-) (e.g., saving notes as a PDF files for easy sync with my Boox device, including reversing the colors of dark images, making it easier to read them on e-ink devices).\n\nThe system is a neat way how to combine **Emacs/Atom/Sublime/iA Writer editor + Markdown Syntax + Git + Html engine** (bootstrap/python) to get the best notes-talking experience ever. Highly customizable with plugins written in Python. \n\nWhat's the most important, under the hood it's just a set of Markdown files.. you can do with them whatever you want, e.g. you can Pandoc (http://pandoc.org/epub.html) them to epub (that's origin of \"book\" part of the name), or you can sync them to your iPhone to be edited with iAWriter (this is how I share my notes with my iPhone).\n\n![](themes/default/qubCXZcWHl.gif)\nFigure. From an (old) homepage to a note.\n\n![](docs/imgs/56HcDqXllz.gif)\nFigure. A new Homepage.\n\n\n  * [Features](#features)\n    * [Index](#index)\n    * [Dashboard](#dashboard)\n    * [Extensions](#extensions)\n  * [EMACS\\-powered](#emacs-powered)\n    * [focus\\-mode](#focus-mode)\n    * [list notes in Emacs (sort by Date/Name)](#list-notes-in-emacs-sort-by-datename)\n    * [magit\\-based diff of your notes](#magit-based-diff-of-your-notes)\n  * [On your OSX](#on-your-osx)\n  * [On your phone](#on-your-phone)\n  * [Install \u0026 Get Started!](#install)\n  * [Food for thought](#food-for-thought)\n\nFeatures | Geekbook | Word Office | Apple Notes\n-------- | -------- | ----------- | -----------\n**Edits with Emacs** | Oh, boy, yes! | Nope | Nope\n**Outline (collapse to headers)** | With Emacs yes. Works great! | Nope | Nope\n**Long notes - easier to browse** | Long notes with great speed and table of content | Very slow for long notes. Always problems with formatting long notes with images. | Very good for short notes.\n**Syntax highlighting** | Oh, boy, yes! | Hmm.. nope | Hmm.. nope\n**Write your own plugins in Python** | Oh, boy, yes! | Nope | Nope\n**Export as a pdf** | Yes | Yes | Yes\n**Edit with ...** | Any text editor (with Markdown support for better UX) | Word | Apple Notes (Closed)\n**Flexible** | Super flexible. You can find your own why how to make your notes | Medium | Medium\n**Search** | Super easy to search with built-in search or just grep your files | More difficult to search over a set of files. Slow! | OK\n**Version control** | Yes, if you use Git etc | Kind of. Hard to use (compared to Git) | Nope\n**Style customizable** | Yes, it's HTML. Do what ever you want | To some extend | Nope\n**Edit on your phone** | Yes, use Byword | Not really | Yes, works very well!\n**Open \u0026 Free** | YES | Nope, closed and pricey | Close, no extra charge if you have an Apple device\n**Super easy to use** | Rather for geek/nerds/hackers | Easy but who cares ;-) | Easy but who cares ;-)\n\n@todo Compare to Evernote.\n\nSimilar projects: it's kind of like Sphinx for your documentation, or Mkdocs (http://www.mkdocs.org/).\n\nFreatures:\n\n- Index html based\n- Sync them with Dropbox/iCloud/github\n- Read from console, grep them\n- Edit with almost any text editor, I'm using Emacs!\n- Keep images separately, edit them in any external tool or edit them in batch\n- Customize html templates\n- You can sync notes in your system with notes kept at virtual machines (mounted via sshfs) or drives\n- Super light!\n- Pandoc markdown files to anything you want!\n- Use 3rd party editors, if you wish, on your computer or on your phone.\n\nI recommend to use **Emacs** (or VIM or other super-powerful editor) to:\n\n- run git on your notes in your editor,\n- grep them in the editor,\n- make bookmarks to parts of your notes,\n- copy-paste from your notes to your programs you're writing,\n- use Google Translate (https://github.com/atykhonov/google-translate)\n- ispell,\n- outline mode,\n- focuse mode.\n\nSync with **Github** to have your notes (full-text searchable) with you all the time (in a private repository):\n\n![index](docs/imgs/geekbookx.png)\n\nKinda similar projects:\n\n- www.geeknote.me\n\n# Features\n## Index\n\n![index](docs/imgs/index.png)\n\n## Dashboard\n\n![dashboard](docs/imgs/dashboard.png)\n\n## Extensions\nGeekbook includes also many plugins that build on top of Markdow to give even more fun.\n\nSee for more \u003chttp://geekbook.readthedocs.io/en/latest/edit.html#geekbook-only\u003e and \u003chttps://geekbook.readthedocs.io/en/latest/quickref.html\u003e\n\nExport one page as a Git repository:\n\n    python page.py /Users/magnus/Desktop/geekbook-export geekbook-export.md --add-toc --push\n\n# Emacs powered\n## Focus on your notes\n\n![](docs/imgs/emacs_focus_mode.png)\n\n## List your notes in Emacs (sort by Date/Name)\n\n![](docs/imgs/emacs_list.png)\n\n## magit-based diff of your notes\n\n![](docs/imgs/emacs_git.png)\n\n[https://www.emacswiki.org/emacs/Magit](https://www.emacswiki.org/emacs/Magit)\n\n# Python-markdown powered\n## Footnotes\n- https://python-markdown.github.io/extensions/footnotes/\n# On your OSX\n\nSpotlight your notes:\n\n![](docs/imgs/osx_file.png)\n\n# On your phone\nOn your phone: (in this case using Dropbox \u0026 Byword on my iPhone).\n\n![](docs/imgs/notes_at_phone.png)\n\nOr Draft (http://lifehacker.com/draft-is-a-clean-note-taking-app-with-markdown-support-844836670) for Android (not tested by me).\n\n![](docs/imgs/iphone_search_byword.png)\n\nSearch on your Iphone to get to the note.\n\nUpdate: Now I'm using iA Writer for iPhone (https://itunes.apple.com/pl/app/ia-writer/id775737590?l=pl\u0026mt=12). It has sync with iCloud (works with sync also images (!)) and Dropbox. Geekbook has a nice plugin to be able to work with iA Writer seamlessly. \n\n![](docs/imgs/ia_writer_iphone.PNG)\n\nIf you insert an image on your phone, the syntax for it will be iA Writer-like. However if Geekbook detects this syntax it converts it to markdown syntax for images (which works as well in iA Writer). \n\n![](docs/imgs/screen800x500-0.jpeg)\n\nMoreover, you can use in Geekbook also syntax `/\u003cfile.md\u003e` to join chapters into books. \n\n![](docs/imgs/screen800x500-1.jpeg)\n\nThere is also a nice app for Mac (https://ia.net/writer/).\n\n# Install\n\nSee http://geekbook.readthedocs.io/en/latest/install.html\n\n# Food for thought\n \n http://geekbook.readthedocs.io/en/latest/thoughts.html\n \n# Markdown Editors\n\nPyCharm - Python IDE and Markdown editor https://www.jetbrains.com/pycharm/\n\nLinux:\n\n- http://www.omgubuntu.co.uk/2017/11/notes-up-markdown-editor-for-linux \n- https://remarkableapp.github.io/\n\nmacOS:\n\n- Bear http://www.bear-writer.com/\n- iA Writer https://ia.net/writer/\n- Typora https://typora.io\n\niOS:\n\n- https://ia.net/writer/\n\n# Quickref\n\n\t\\ii get a file from ~/Desktop\n\t\\ix get a file from ~/Downloads\n\t\\dx get a file from ~/Dropbox\n\n\t\\ip get a file from selected in Apple Photos\n\t\\ic get clipboard\n \n    #dark to make a figure dark (inverse colors)\n\n\t'[notes]', '\\pagebreak'\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmagnus%2Fgeekbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmmagnus%2Fgeekbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmagnus%2Fgeekbook/lists"}