-
Notifications
You must be signed in to change notification settings - Fork 803
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
fix #34 and #435 #541
fix #34 and #435 #541
Conversation
a| | ||
[source, asciidoc] | ||
---- | ||
+literal+ or `literal` |
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.
Let's use the modern syntax only, so drop the +literal+
one.
A fantastic start! I added some inline comments. The next question to ask is, what's missing? I think it's fine to merge before it's perfect, but it's an important step for identifying the next action. |
I'd like to include a statement for the intro similar to the one proposed in #34.
It's important to understand that AsciiDoc was born out of DocBook. That gives people confidence that it isn't just shooting in the dark rather than just trying to patch needs like Markdown. We could use less words, though. |
I think there are a few missing comparisons that are covered in the following page: I also think we should link back to issue #34 for people who want to dive deeper. Even though the issue will be closed by this PR, it still holds some detail that isn't appropriate for adding to the user manual. Say something like:
|
I implemented some fixes following your comments. As for what is missing, maybe some notes on tool availability? |
Thanks! I think the discussion of tooling is out of scope. The focus of this section is really on the syntax, IMO. |
You are right 😄 |
I added two more asciidoc only features: split source and custom css classes |
@mojavelinux What do you think of this link by Scott Chacon? I believe it’s a beautiful proof of asciidoc’s value from a well-known actual technical writer; IMO, we should link to it; where? |
See #530. |
Aah, I missed it 😄 |
A first draft (mostly using Dan’s own writings on a github issue) so that the section isn’t fully empty.
Please comment =D