Git Product home page Git Product logo

auteur's Introduction

Auteur

Auteur is a highly customizable and configurable blog site creator, written for bloggers who desire to create their own blog website and "get their hands dirty" with the HTML and CSS, but avoid the costly maintenance required to write it by hand. You can see a small demo of Auteur in action here: http://www.gensonsoftworks.com/auteur-demo/

Please keep in mind that while Auteur is usable, it is still in the alpha stage of development, so some features and niceties are missing, and it hasn't been tested on all platforms. Platforms it has been tested and known to work on include recent versions of Fedora and Ubuntu.

Requirements

Before downloading Auteur, make sure your system meets the following list of requirements:

  • Operating system: Fedora 27 or Ubuntu 17.10 (other platforms may work but have not been tested)
  • Python 3.6 is installed
  • Markdown for Python 3.6 is installed

Getting Started

What follows is a brief tutorial on how to create your first Auteur project.

  1. Download the Auteur source from here: https://github.com/jerradgenson/auteur/archive/master.zip
  2. Extract Auteur into the directory of your choosing. No install scripts exist for Auteur at this time but you may make links in your bin directory manually or simply run Auteur from the extraction directory.
  3. Create a new directory for your blog project. It can be anywhere on your machine. For simplicity's sake, we'll refer to this as the blog directory.
  4. Copy "resources" and ".auteur" from the auteur directory to your blog directory.
  5. Open "resources/config.json" and fill in the missing configuration details for your site.
  • root_url is the URL for the homepage of your blog site. Example: "http://www.gensonsoftworks.com/auteur-demo/"
  • blog_title is the title of your blog site. Example: "Auteur Demo"
  • blog_subtitle is the subtitle for your blog site. This may be left blank if your blog has no subtitle.
  • owner is the copyright holder for the blog site. This is not necessarily the same as the author of your posts.
  • email_address is the address that users of your site can use to get in contact with you.
  • description is a brief description of your blog's content and target audience.
  1. If you wish to display a background image on your site, you can add a file named "background.jpg" to the resources directory.
  2. You are now ready to write your first blog post! Create a subdirectory in your blog directory for the post.
  3. Blog posts are written in Markdown. Create a Markdown file (plain text file ending in ".md") in the subdirectory for your blog post.
  4. Autuer will use the first H1 heading it finds as the blog post title. Beyond that, you can use any Markdown formatting you choose in your posts. See here for more information on Markdown: https://daringfireball.net/projects/markdown/syntax
  5. Once you're done writing your post, use Auteur's add command: auteur.py add <path-to-blog-post.md>
  6. When you're ready to create the blog site, use Auteur's build command from the root of the blog directory: <path-to-auteur.py> build
  7. Anytime you make a change to an existing blog posts, you can use the build command to update the site.
  8. Finally, upload the blog directory to a web host of your choosing. The site should now be working and accesible on the Internet.

auteur's People

Contributors

jerradgenson avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

auteur's Issues

Better article subtitles

At present, article subtitles are constructed from a special date tag included in source Markdown files. Support for the date tag should be dropped; in its place, a level two heading following the level one heading should be used as the subtitle, when it exists.

Create unit tests

A full suite of unit tests should be created for the functions in Auteur.

Custom 404 error

Make custom 404 error page that integrates with the rest of the blog website.

Custom 403 error

Make custom 403 error page that integrates with the rest of the blog website.

Add `init` subparser

A subparser init needs to be added to the Auteur command line parser for initializing new project directories. Essentially, this will copy vanilla configuration and resource files from the global Auteur installation. It should also include an interactive mode to walk the user through setting configuration values.

Including figcaption text in article previews

When Auteur parses HTML from blog articles to extract preview text for the home page, it includes figcaption text if it's contained in paragraph ("

") tags. It should ignore all text contained in a figure ("

") tag.

Add `rm` subparser

A subparser rm needs to be added to the Auteur command line parser for removing articles from the blog website.

Don't quote RSS URLs

The RSS feed generated by Auteur contains quoted URLs that some web browsers don't interpret properly. Fix this by simply not quoting the URLs.

Add comment system

Create a comment system so that users can respond to and discuss blog articles directly on the blog website.

Create default theme

A default blog "theme" needs to be created, including a style sheet, background photo, and favicon.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.