Table of contentsBack
Prose.io is called "a content editor for GitHub". One thing is does really well is it gives people the ability to update their own websites, especially those who don't have the time and energy to learn how to write code. While there is plenty of great technical documentation for Prose on GitHub, there is very little documentation for people who don't code. Prose is very similar to the visual editor included in WordPress that many people use for writing blog posts. But not everybody has a WordPress website and I encourage most of my clients to steer clear of it (4 Reasons to Leave Wordpress).
This documentation is intended for those who are new to using Prose. It follows the process of publishing a new blog post from start to finish on a site powered by Jekyll.
I plan to create a video tutorial series for each of the topics below. Enter your email address and be notified as soon as each part of the video series is released.
Create a new postBack
Add a featured imageBack
If you are going to add a featured image to the post I recommend you do this step first.
First, make sure your image is the proper size before you upload it.
On a Mac follow these steps:
- Open the image in Preview, the default Mac image viewer.
- On the toolbar, go to "Tools -> Adjust Size...".
- Ensure "Resolution" is set to 72.
- Adjust the width to your preferences. Generally 1500px is close to full screen width on medium sized laptops. 150px is a good thumbnail size.
- The height will adjust automatically when you change the width.
- Don't forget to save your changes!
Now click the image button on the toolbar and drag and drop an image into the box or click "selecting one" and browse for the image file.
Rename the image if you wish but make sure the filename begins with "images/" as seen in the example.
Click "Insert" when you are finished. Confirm that the image is being uploaded properly by looking at the save button in the sidebar. It will keep you informed of the image upload progress.
When the image is finished uploading a "Saved" message will display and Prose will generate a line of image code for you.
Next copy and paste the featured image raw HTML block into the post,
and replace the stars with the name of the image file you just uploaded. Be sure to keep "/images/" before the filename.
Make featured image available to facebookBack
After you have uploaded the featured image, click the “Meta Data” button on the sidebar. In the “Featured Image” text box update the filename of the image by replacing the stars with the name of the image file you just uploaded. This will make the featured image available when you share your post on Facebook and other forms of social media.
Be sure to keep /images/ before the filename.
Write your postBack
You can use the editor to write your post. If you have previously written your post in a Word document then you can paste your post into the editor. Be sure to check all formatting since bold, italics, numbers, and bullets will not paste nicely into the Prose editor. There are buttons on the toolbar that you can use for this formatting.
If you have a paragraph that needs special formatting (e.g. center alignment) you can wrap the paragraph in HTML with the proper class added to it. Be sure to include a space between each unique class name.
If you are composing your post for the first time in the Prose editor, use the "Save" button frequently. It is safe to save and commit your post as many times as you'd like. There is a separate step for publishing your post before it is live on your website.
Add an excerpt separatorBack
A post excerpt includes the featured image and a small preview of the post. It can be used in many places but is most commonly seen on main blog pages and in RSS feeds.
You can add images to your post in addition to the featured image. Follow the same steps for uploading your image as you did for the featured image. You can either leave the image as it is when you upload it or you can align it by replacing the stars in the different HTML examples below.
Save and publish your postBack
So you clicked save and you got a red exclamation point. No worries, just click the project name at the top of the page to return back to the project file listing.
Then click the post that you are trying to publish.
Or if you want to start over you can click the trash can on this page to delete your work
Then navigate to your blog to check our your new post!
Note: it may take a few minutes for your website to build the new post, especially if it contains large image files. Be patient and check your email if you think something went wrong. GitHub will send you an email if there are any errors with your page builds
Questions and commentsBack
Is something unclear? Have a made a mistake somewhere? Do you want to use Prose.io to maintain your site?
Leave a comment below or contact me directly to get the conversation started.