Giter Club home page Giter Club logo

aaronsaray.com's Introduction

aaronsaray.com

Source for AaronSaray.com

Writing Process

I forget too many things, so I take notes for myself. Don't lie - you wish you would do the same...

Create a New Entry

Blog Write.alfredworkflow provides the bw command which accepts a parameter of a filename for the new draft. It puts the file in the _drafts folder as a markdown file (specifying .md when creating the new file is not required). The file is git added. (I version my drafts just in case of a filesystem failure and a back-up failure.)

Save Progress

When done writing, run bs which will blog save - which is basically committing and adding all changed files and pushing them to master. This is not the same as publishing. Blog Save.alfredworkflow provides this functionality.

Publish Draft

All this does is move a file from the drafts folder to the post's folder, but it prepends a date onto the filename. This sets the published date for the UI and for ordering. The command is bp which will give a list of items from the drafts folder. This functionality is provided by the Blog Publish Draft.alfredworkflow file.

Pushing to Production

The jekyll site will be built to _site and then an rsync command will make sure the updated entries exist on the remote server. Notifications will be issued along the way. This is provided by the Blog Update:Submit.alfredworkflow file.

Writing Standards

I'm either way too anal - or this is just because I forget things. You get to decide!

Entries

All entries, when using headers, should start with h3 (###) and only go as deep as h4 (####).

When referring to a filename for a code sample, put it above the code sample, use inline code syntax and make it bold. For example:

**`test.html`**
```html
<h1>hi!
```

Code will be highlighted using the markdown indication and highlighter plugin for Jekyll as such:

```css
Some code here
```

Where CSS can be any supported language. The initial indent of the code should be no spaces.

Code should be indented with only two spaces, and should make every effort not cause the code block to need to scroll at largest allowed viewing.

Code files that refer to the entire file should begin with that language's first tag. Others may make use of start_inline=1

So if a PHP file is the entire file, it should have <?php to begin. If it's an excerpt, the definition should use start_inline=1.

Images with thumbnails will be embedded like this:

[![Load Time Analyzer - Test 2](/uploads/2007/test-2-load-time-analyzer.thumbnail.png)](/uploads/2007/test-2-load-time-analyzer.png){: .thumbnail}

The last part is part of kramdown and is required for a class.

Linking internally to blogs will be done with the internal post link system:

[here]({% post_url 2007-06-24-load-time-analyzer-for-firefox %})

Files should always be code and bold. For example:

filename.php

aaronsaray.com's People

Contributors

aaronsaray avatar

Watchers

James Cloos avatar  avatar

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.