Github has taken the humble README file and elevated it to star status by using Markdown. But after you've written a few of those, you start hoping that something will come along to take it to the next level.
Blue-phrase notation is a natural for documenting things, and with the --emit option set to "Github Flavored Markdown", you can write your next source code documentation as readme.blue and instantly convert it to readme.md on your next commit.
With Read Write Tools your once humble documentation can become a source of pride. Here's a portion of a real example (rwserve-custom-header):
BLUE-PHRASE BasicsGetting started with symbolic endophrasing. Learn how to author documents with many of the commonly used typographic techniques found in word processors, by using BLUE-PHRASE symbolic endophrasing. There are only a few basic rules to learn.
BLUE-PHRASE EssentialsA primer for effectively using BLUE-PHRASE. Learn the essentials necessary to effectively use BLUE-PHRASE, and discover techniques to perform commonly occurring tasks with greater ease using shorthand notation.
BLUE-PHRASE + CSSThe fundamentals of styling Learn how to style BLUE-PHRASE with Cascading Style Sheets.
BLUE-PHRASEHTML templating and blogging. A computer language for solving problems related to reading, writing, and publishing.
READ WRITE GROKA different take on a tech blog. Follow along as Tangled Web Services boldly goes where tech has gone before.
Read Write Tools is able to offer free and low-cost software products because it has low overhead and limited staff. We are happy to answer your customer service and technical support questions when our self-service options aren't able to meet your needs.
Many of the most common customer service issues can be resolved without our help. Check the licensing and accounts pages for ways to resolve issues related to registration, customer numbers, passwords and access keys.
Technical support issues can sometimes be resolved using one of the public forums like Stack Overflow, so search for error messages, blue-phrase syntax questions, and technical problems there. For best results include the name of the product in your search, like rwdoc, rwreuse, rwserve, etc.
Read Write Tools Software License Agreement. The ReadWriteView, ReadWriteNote, ReadWriteDoc, and ReadWriteReuse desktop applications; and the ReadWriteServe server software may be used only in conjunction with the purchase of a software license.
Read Write ToolsOpen Source Software. Read Write Tools publishes some of its software portfolio under open source licenses, including RWSERVE plugins, web components, CSS style sheets, editor themes, command line build tools, and Node.js libraries. These are covered by two different open source licenses: the MIT license or the Creative Commons CC-BY-NC-ND 4.0 (Attribution-NonCommercial-NoDerivatives 4.0 International). See each individual file or its associated README file to learn which applies.
While you are browsing our website, we log all HTTPS requests from your browser and all responses by our servers.
Each time you use our software, we verify the authenticity of your license key using the device address of your computer, and the IP address of your computer network. We use this data to prevent piracy, and to block unlicensed use of our software.