tighten / gistlog Goto Github PK

Please add support a anonymous secret gists, currently they pops-out error if you use them. Example
https://gist.github.com/anonymous/2c2769b21e512eabdd72

Looks like there are missing styles for markdown / html tables.

E.g. 💃

The README.md lists a PHP version requirement of <= 5.5.9

Really? Is it really a less-than-or-equal requirement?

Examples of inconsistency:

• Right now our CSS has a gistlog component, but we're calling the posts just Gists in the backend.
• I'm using $gist->author for the user who created the post, but $comment->user

I think it makes sense to come up with a name for our "posts" (whether that's "gistlog" or whatever) and use that consistently for any related front-end components, and references in the backend. Will help to create a distinction between raw Gists we are pulling in from GitHub and the article that we create out of a Gist.

• A code block in a list is bigger

than a code block in body text.

Seems like there are different font-sizes for code declared.

Example: https://gistlog.co/m6w6/360f33cd8f0fb2f78028eb8d4ea77254

Depending on your browser and/or font, you might have to change the zoom level for the obvious effect.

super rough and low fidelity on purpose

Wanted to get some ideas out of my head and on to paper while talking through thought process and goals for this.

I would like to establish the tag line for what Gistlog is. One idea I had was "Your DevBlog Delivered", with a subtitle hook of, "Create your first (blog) post in 45 seconds" to emphasize how quick it is to get it up and running. This is the reason I use it and I think why other people would use it as well.

Mockup walkthrough: On the right hand side, this would be a small html5 video or gif showing the process for creating a gistlog or showing off a gistlog post.

To the left below the text and tag line is the input field to paste a gist url to create a gistlog.

Below the main hero, we have the three steps to getting started

1. Create a Gist with Markdown
2. Paste your Gist url into Gistlog
3. Share your Gistlog link (Celebrate)

Features section (some ideas)

1. Responsive out of the box
2. Easy and Fast
3. Powered by Github
4. Built in comments (and notifications by giscus)
5. Written with Markdown
6. FREE

We could also have a docs page that would be separate and would explain some of the nuances like author pages, options inside of the gistlog.yml file, etc...

As seen here

https://github.com/tightenco/gistlog/blob/master/app/Gists/Gistlog.php#L98

The preview assumes a length of at least 200 characters when rendering the preview. Will submit a PR for this but wanted to make an issue before I forgot.

On gist.github.com, the table in a code block without any language set doesn't have syntax highlighting.

https://gist.github.com/raine/d12d0ec3e72b2945510b#render-as-table

However, if you look at it on gist log:

https://gistlog.co/raine/d12d0ec3e72b2945510b

it tries to awkwardly color some things which I think it shouldn't do.

We must not have the same caching running on the author pages. Would love any help from anyone who has time available?

[2015-07-24 15:45:02] production.ERROR: exception 'Exception' with message 'You have reached GitHub hour limit! Actual limit is: 5000' in /home/forge/gistlog.co/app/Authors/AuthorClient.php:37

Make the column width narrower, font bigger, font serif

No idea on what the implementation would be, how things would be scored, or anything, but it would be cool if the home page could show trending posts so you can see what people are reading.

Could be an upvote system, view count, shares, who knows, but the general job story is something like:

When I'm looking for interesting tech writing to read, I want a way to discover posts that are getting a lot of attention, to help me keep up with what others are talking about in the tech community

Because we used medium media query break

That's not cool (and I'm sure I'm the one who introduced it)

I think having dates would give a more blog post like feeling.

What should determine the date then?

I can think of two options,

1. When the gist was created
   • + no-configuration
2. YAML front matter
   • + date doesn't have to be shown
   • + date can be set to arbitrary time
   • - looks messy on gist.github.com

---
date: 2015-03-20

---

# My gist

Thoughts?

If user tries to display a file that's not markdown, wrap it in a code block

Potential future feature idea: users can auth in via Github, choose which posts to publish, and those all go on a list at gistlog.co/username.

OR, some flag in the post to make it published?

Maybe something in the post name... or a second file attached that's a yaml file with metadata?

When embedded within a markdown blog post, syntax highlighting doesn't work on yaml code blocks

Hey,

Does this project wanna stay on LTS. Was shifting and then realised it was on LTS and thought...probably wanna stay there.

In regards to our discussion on #117 or more specifically this comment, what type of settings would we want to make available to authors? Here are a few thoughts.

• Twitter Username
• Author Webpage
• Google Analytics Tracking Id (UA thingy)

Seems pretty minimal I know. Would love to hear feedback.

Eg this on iPhone :
http://gistlog.co/prestonparris/ec7597efd4d4977b54af

This is my gist

https://gist.github.com/RobinMalfait/ad4be1e4d319afb41df5

This is the result

https://gistlog.co/RobinMalfait/ad4be1e4d319afb41df5

I don't know what's going on here :)

Using the description as the big header means that gists will look a bit weird on gist.github.com since you can't use h1 at the top of the document, as otherwise you'll have double header on gistlog.

Would it be to much magic to read first h1 from gist as the big header, and use description as some kind of short text under the big header?

Just my 2¢.

edit:

I also noticed that gist.github.com gets the gist page's <title> from description. If one wants to have sensible title there and a header in the document, there will be a double header on gistlog.

https://gistlog.co/RobinMalfait/c66305a3e9a533e8d018
vs.
https://gist.github.com/RobinMalfait/c66305a3e9a533e8d018

Code in the first block is wrapping and then getting marked as a new line

This used to be a valid URL:

https://gistlog.co/kayladnls/e5bff1a7c1f85d83c37f5294b9fe8e03

Then after a username change it became invalid.

Is it possible to ask github for a user's new/old username in this context? Would be nice if people don't break all their links when they change usernames.

/cc @greydnls

Maybe you can add multiple files in a tab form way?

Like

• https://gistlog.co/raine/988b18c286a3d6bc9cd4
• https://gist.github.com/raine/988b18c286a3d6bc9cd4

The link on the comment timestamp leads to a non-existent anchor on the gist page.
It should be #gistcomment-1676047 instead of #comment-1676047.

This has to be changed here:
https://github.com/tightenco/gistlog/blob/master/app/Gists/Comment.php#L47

Medium being the inspiration... would be cool to have a toolbar-ish listing of how many comments and how many stars a gistlog has at the bottom as a reader is scrolling. Could also contain links to share it on twitter, facebook, etc.

Users could also use this toolbar to star the gist directly on github after authenticating.

Looks terrible: http://gistlog.co/prestonparris/ec7597efd4d4977b54af

Relative note: Markdown renders every list item as a paragraph in a list, so our normal paragraph styling should pretty much all be > p in order to not accidentally style list items.

Thanks @davidhemphill for the idea: https://twitter.com/davidhemphill/status/569927977233829888

It seems to exist, but I can't get it working.

I tried both livescript and ls with code fence block.

https://github.com/isagalaev/highlight.js/blob/master/src/languages/livescript.js

Example: https://gistlog.co/raine/6486b985c767954781b1

Sample from Giscus:
tighten/giscus@bb8f124

Problem: 5000/hour rate limit.

https://gistlog.co/raine/d12d0ec3e72b2945510b

It's better to scroll horizontally than wrap lines of code unpredictably.

This has to do with the transition to using the Github parser to handle our markdown. The code blocks are no longer surrounded by <code> as hljs.js expects them to be. Will need to write a custom init block for hljs to detect the code blocks and highlight them.

The config options being passed into hljs for languages are currently restricting the list of highlighted languages to php only.

The function to add line numbers is failing as well.

I'll try to submit a PR tonight to handle these issues.

Reference #102 and PR #104

Create a 404 page that gives the user some options to return back to the gistlog index or possibly suggestions for other authors they might have been looking for.

Comments that use Markdown are currently unformatted and line-breaks are removed.

Would be helpful when working on styling to have a good sample post that includes:

• Multiple types of sub-headings
• Lists and nested lists
• Code samples
• Quotes
• Images

Github has a method of creating checkboxes with Markdown that does not appear to be supported on Gistlog.

Here are the following Markdown options for indicating an unchecked & checked checkbox:

- [ ]
- [X]

Though I believe they can support any of the following:

- [ ]
- []
- [X]
- [x]

You might be able to replace those with the standardised Unicode characters that best represent a checkbox:

☐ Checkbox Unchecked ☐
☑ Checkbox Checked ☑