Scriptor Jekyll Theme

Overview

Scriptor is a Jekyll theme designed specifically for writers. It features a simple, minimal, and clean design that is also fully responsive. The theme allows writers to showcase their work and engage with readers through features such as an organized archive by tags and Disqus comments. Scriptor also offers customizable accent color options and the ability to highlight code using the Prism syntax highlighter.

Features

• Responsive design: The theme is fully responsive, ensuring a seamless experience for readers on all devices.
• Archive organized by tags: Writers can easily organize their work and make it more accessible to readers by tagging their posts and organizing them in the archive accordingly.
• Disqus Comments: The theme integrates Disqus comments, allowing readers to engage with the writer and each other by leaving comments on posts.
• Accent color options: Scriptor offers customizable accent color options, allowing writers to personalize the theme to match their brand or preferences.
• Prism syntax highlighter: Writers who include code snippets in their posts can utilize the Prism syntax highlighter to enhance the readability and presentation of their code.

Installation

To install and use the Scriptor theme for a Jekyll site, follow the steps below:

1. Clone or fork the Scriptor repository.
2. Set up Jekyll by following the official documentation on the Jekyll docs website.
3. Navigate to the cloned or forked repository and run bundle install to install the necessary dependencies.
4. Run bundle exec jekyll serve to start the Jekyll server.

Please note that while Scriptor cannot be configured and installed as a theme, you can still use the repository as a theme by adding your own content to it.

Deployment

Local Installation

To set up Jekyll on your local machine, refer to the official Jekyll documentation. Once Jekyll is set up, you can run the Scriptor theme locally by following these steps:

1. Navigate to the theme directory in the cloned or forked repository.
2. Run bundle install to install the dependencies.
3. Run bundle exec jekyll serve to start the Jekyll server.

Manual Deployment

By default, Jekyll outputs the static site to the _site directory. To deploy your site manually, you can transfer the contents of this directory to any hosting provider.

Netlify

The Scriptor theme is prepared to be hosted on Netlify. To deploy the theme on Netlify, follow these steps:

1. Create a new private repository on GitHub or GitLab.
2. Upload the Scriptor theme to the repository.
3. Link your repository to Netlify.
4. Refer to the step-by-step guidelines provided by Netlify for more information.

Amazon S3

If you prefer to host your site on Amazon S3, you can use the s3_website application. This application allows you to push your site to Amazon S3, where it can be served like any web server and dynamically scale to handle high traffic.

For additional deployment methods, please refer to the Deployment Methods page on the Jekyll website.

Summary

Scriptor is a simple and clean Jekyll theme designed for writers. It offers a responsive design, organized archive with tag filtering, Disqus comments, customizable accent colors, and a syntax highlighter for code snippets. The theme can be installed and used locally by following the provided instructions or deployed on platforms like Netlify or Amazon S3. All files and directories in the theme are licensed under MIT, unless otherwise stated.