-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Asciidoc file type documentation #51
Conversation
@@ -66,6 +66,12 @@ Ruby `String`, allowing for expressions such as | |||
|
|||
# This is the \#{page.title} | |||
|
|||
### AsciiDoc (`.adoc`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The extensions .asciidoc
and .ad
also work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As much as we like .ad
, it hasn't really caught on and people seem to be using .adoc
now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It hasn't caught on because GitHub basically said no. Otherwise, I would have switched everything to it. You are right, though, that adoc is gaining the adoption. I think it's still worth mentioning that we support the other ones, so perhaps we can list them in priority order.
.adoc, .asciidoc, .ad, .asc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bah, I personally dislike having multiple file types for the same file type. It just confuses people. Remember all the URL's you visited that ended with html and needed to end with htm?
But of course, if the official file types are all 4 (.adoc, .asciidoc, .ad, .asc) - which is not my decision to make - and that's not about to be changed, we should list all 4.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't mention asc, that one is just bad, especially on non-windows boxen because of gpg default extensions.
Sent from my iPhone
On Oct 11, 2013, at 23:14, Dan Allen [email protected] wrote:
In file_types.md:
@@ -66,6 +66,12 @@ Ruby
String
, allowing for expressions such as# This is the \#{page.title}
+### AsciiDoc (
.adoc
)
It hasn't caught on because GitHub basically said no. Otherwise, I would have switched everything to it. You are right, though, that adoc is gaining the adoption. I think it's still worth mentioning that we support the other ones, so perhaps we can list them in priority order..adoc, .asciidoc, .ad, .asc
�
Reply to this email directly or view it on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm also trying to discourage the use of .asc
. Perhaps we should remove that one from Awestruct outright.
@ge0ffrey I don't mind recommending one and putting the others in footnotes. The reason there are so many file types supported is because that's the current state of things. We are attempting to converge on a favorite, which at the moment seems to be .adoc
, but there are many docs out there already that use the other extensions.
The other thing to consider is that the file types are actually managed in Tilt, not in Awestruct. We are overriding the implementation in Awestruct atm, so we also list the extensions in Awestruct, but that's just to cover what Tilt already recognizes. I think we can deregister extensions from Tilt, though. Perhaps open an issue for this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added the the 2 other file types (except for .asc) in the pull request. Should be good to merge now.
Asciidoc file type documentation
No description provided.