Tag: sync

How to Keep Your Notion Docs Synced with Your Repositories Using readme2notion

Reading time: 4 – 6 minutes

Tired of updating documentation across multiple platforms? If your projects rely on Notion for planning and GitHub for collaboration, you might find yourself constantly re-copying information from your repository to your Notion pages.

Here’s a simpler solution: readme2notion.

This handy command-line tool allows you to sync your Markdown files directly to Notion, saving time and keeping everything in one place.

Why Syncing Docs with Notion Matters

Many businesses, freelancers, and creators rely on Notion for organizing their workflows and GitHub for managing code and documentation. But each time your repository changes, your Notion page can easily fall out of date, creating a disconnect between your development work and your project documentation. readme2notion bridges this gap by automatically updating your Notion pages with the latest content from your repositories. You get an always-up-to-date Notion page that syncs with your codebase, so everyone on your team has the latest info in real time.

What is readme2notion?

At its core, readme2notion is a command-line tool that takes a Markdown file, converts it into Notion blocks, and uploads the content to a specified Notion page. This tool is versatile, finding the appropriate Notion page by name or creating one if it doesn’t exist. Once set up, it can transform your Markdown files into well-organized Notion pages with just one command.

How readme2notion Works

  1. Markdown Conversion: The tool reads your Markdown file and converts it into Notion-friendly blocks.
  2. Upload and Sync: It then uploads the converted content to a Notion page, either updating an existing page or creating a new one based on the settings you choose.
  3. Automated Updates: With a pre-push hook, readme2notion can automate the process, so every time you push a new change to your repository, your Notion page stays updated without any extra effort.

Key Features of readme2notion

  • Simple Conversion: Easily converts Markdown text into Notion’s block-based format.
  • Automatic Page Updates: Finds or creates the appropriate Notion page in the database you specify, meaning your docs are always up-to-date.
  • Pre-Push Hook: This feature allows for completely automated updates to Notion. With every push, your Notion page gets a fresh update, making it perfect for remote teams or anyone who needs a reliable source of truth for documentation.

Why You Should Try readme2notion

Updating Notion pages by hand can be tedious, especially if you’re a developer or creator juggling multiple projects. This tool eliminates the hassle by letting you write documentation once in your repository’s README file and automatically reflecting those changes in Notion. Plus, readme2notion works seamlessly within your existing Git workflows, allowing your team to focus on what matters—building and creating—while staying informed and organized.

If your documentation process could use an upgrade, give readme2notion a try. It’s the easiest way to ensure your Notion workspace always reflects the latest state of your codebase.

Podcast 1×05: queixant-me de tot una mica i podget

Reading time: < 1 minute Avui el podcast ha estat de queixes i un petit apunt tècnic de com baixar-se podcast a l'estil iTunes però versió més friki. Res un tonteria de podcast, però n’hi ha de bé tot tipus.

Enllaços:

  • podget – descarregar podcasts prou ben fet, per ser un shell script
  • synkron – sincronitzar fitxers fitxers, amb interficie mono

Google Browser Sync

Reading time: 2 – 2 minutes

Es tracta d’una eina programada per google que s’integra perfectament al firefox i que ens permet guardar les sessions, bookmarks, cookies, històric, passwords, etc. de les nostres màquines a internet, així quan canviem de màquina podem seguir la sessió de navegació en el punt ho varem deixar. A mi em va com l’anella al dit, ja que sovint navego per internet amb l’ordinador de casa sense connectar el portàtil i quan arribo a la feina sempre trobo a faltar passwords, historics i fins hi tot pàgines que tenia obertes i que encara no havia guardat. Potser el que menys m’interessa és el tema dels bookmarks, perquè uso el sitebar i ja ho tinc tot ben automatitzat amb els enllaços de la barra d’enllaços personals. Però si altero el contingut d’aquesta barra que en el fons és una carpeta dels bookmarks del firefox també es sincrontiza, m’encata. Ja era hora que sortis una eina com aquesta!

googlebrowsersync.png

A més funciona tan en firefox per windows, linux i mac. De fet, jo no tinc mac. Però fins hi tot dintre del propi portàtil quan estic en win i estic navegant i me’n vull anar a linux és un fàstig haver de passar les pàgines que tenia obertes de formes poc elegants. Per exemple, sovint el que feia era crear un fitxer .txt on copiava les URLs i quan entrava a linux obria altre cop els tabs amb aquestes urls usant una extensió que es diu linky.

Si voleu provar l’aplicació de google labs la teniu a Google Browser Sync. Realment de les millors aplicacions que m’he instal·lat ultimament 🙂

Scroll to Top