Home / Companies / ReadMe / Blog / Post Details
Content Deep Dive

Edit ReadMe pages from your local machine

Blog post from ReadMe

Post Details
Company
Date Published
Author
Dom Harrington
Word Count
202
Company Posts That Month
1
Language
English
Hacker News Points
-
Summary

A new API feature in the rdme command line tool now allows users to edit documentation pages locally and then upload changes back to ReadMe without losing the ability to continue editing on the platform. This feature is particularly useful for making quick fixes like find-and-replace operations directly from markdown files in a codebase. The docs:edit command facilitates downloading the page for local edits by fetching the page content through the API and opening it in the user's configured local editor. After making changes, the updated content is uploaded to the ReadMe project, and the local file is deleted, thus enabling advanced editing workflows while maintaining the flexibility of modifying content in ReadMe.

Trends Found in this Post

No tracked trend matches for this post yet.