Commit 5c627db6 authored by Dan Allen's avatar Dan Allen Committed by Guillaume Grossetie
Browse files

copyedits and refinements

- change wording in tagline
- use different first sentence to make try it now section flow better
- remove "prepared" in front of screenshots
- fix the meaning of how AsciiDoc strikes a balance
- replace "know how" with "understand how" in Publish panel
- fix sentence per line formatting
- fix placement of dashed underline using text-underline-offset
- remove track color from scrollbar in comparison blocks
- fix overflow on playground editor
- prevent editor from grabbing or transferring scroll
parent aecffd70
......@@ -5,5 +5,8 @@
"comment-empty-line-before": null,
"no-descending-specificity": null,
"selector-id-pattern": null
}
},
"ignoreFiles": [
"pages/assets/subfont/**.css"
]
}
......@@ -17,9 +17,9 @@
--gray-color-500: #6b7280;
--gray-color-600: #3e3e3e;
--gray-color-800: #202020;
--gray-color-900: #18191F;
--brand-font-primary: Inter__subset, "Inter", blinkmacsystemfont, -apple-system, "Segoe UI", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", "Helvetica", "Arial", sans-serif;
--brand-font-secondary: Urbanist__subset, "Urbanist", blinkmacsystemfont, -apple-system, "Segoe UI", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", "Helvetica", "Arial", sans-serif;
--gray-color-900: #18191f;
--brand-font-primary: "Inter__subset", "Inter", blinkmacsystemfont, -apple-system, "Segoe UI", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", "Helvetica", "Arial", sans-serif;
--brand-font-secondary: "Urbanist__subset", "Urbanist", blinkmacsystemfont, -apple-system, "Segoe UI", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", "Helvetica", "Arial", sans-serif;
}
html {
......@@ -88,19 +88,24 @@ body {
padding: 0.5rem 2rem 1.25rem;
gap: 2rem;
font-family: var(--brand-font-secondary);
z-index: 1;
}
.header .menu.is-active {
display: flex;
}
.header .menu a:hover {
text-decoration: underline;
}
@media screen and (max-width: 767px) {
.header .menu.is-active {
position: absolute;
background: white;
width: 100%;
z-index: 99;
box-shadow: 0 10px 15px -3px rgba(0, 0, 0, 0.1), 0 4px 6px -2px rgba(0, 0, 0, 0.05);
box-shadow: 0 10px 15px -3px hsla(0deg 0% 0% / 10%), 0 4px 6px -2px hsla(0deg 0% 0% / 5%);
}
}
......@@ -116,6 +121,10 @@ body {
.header .menu {
display: flex;
flex-direction: row;
gap: 2.5rem;
padding: 0.75rem;
margin-left: auto;
}
.header .logo {
......@@ -152,17 +161,6 @@ body {
text-decoration: none;
font-weight: 700;
}
.header .menu a:hover {
text-decoration: underline;
}
.header .menu {
flex-direction: row;
gap: 2.5rem;
padding: 0.75rem;
margin-left: auto;
}
}
@media screen and (min-width: 1024px) {
......@@ -171,6 +169,7 @@ body {
padding: 0.75rem;
margin-left: auto;
}
.header > nav {
padding-right: 7rem;
padding-left: 7rem;
......@@ -260,7 +259,6 @@ header .logo > img {
margin: auto;
z-index: 10;
position: relative;
text-align: center;
}
@media (min-width: 640px) {
......@@ -675,59 +673,6 @@ section.try .toggle {
/* stylelint-enable selector-class-pattern */
#editorPreview .listingblock > .content {
position: relative
}
#editorPreview .listingblock code[data-lang]::before {
display: none;
content: attr(data-lang);
position: absolute;
font-size: .75em;
top: .425rem;
right: .5rem;
line-height: 1;
text-transform: uppercase;
color: inherit;
opacity: .5
}
#editorPreview .listingblock:hover code[data-lang]::before {
display: block
}
#editorPreview .listingblock.terminal pre .command::before {
content: attr(data-prompt);
padding-right: .5em;
color: inherit;
opacity: .5
}
#editorPreview .listingblock.terminal pre .command:not([data-prompt])::before {
content: "$"
}
#editorPreview .listingblock pre.highlight {
padding: 0
}
#editorPreview .listingblock pre.highlight > code {
padding: 1em;
-webkit-border-radius: 4px;
border-radius: 4px
}
#editorPreview .listingblock pre.prettyprint {
border-width: 0
}
#editorPreview p {
margin: 0;
padding-bottom: 0.75rem;
}
#editor {
padding: 0.5rem;
margin: 1rem auto;
......@@ -756,10 +701,6 @@ section.try .toggle {
grid-template-columns: minmax(0, 1fr) minmax(0, 1fr);
grid-template-rows: 380px;
}
#editorCode .cm-editor {
max-height: none;
}
}
@media screen and (max-width: 919px) {
......@@ -819,6 +760,7 @@ section.try .toggle {
span.attn {
text-decoration: underline 0.5px dashed rgba(255 255 255 / 50%);
text-underline-offset: 15%;
}
/* compare */
......@@ -998,7 +940,7 @@ section.tools a.explore::after {
@media screen and (min-width: 480px) {
section.tools a.explore {
text-align: justify;
text-align: justify;
}
}
......@@ -1077,7 +1019,7 @@ section.tools .cards > .card {
section.tools .cards > .card p {
font-size: 1rem;
line-height: 1.625rem;
color: var(--gray-color-600)
color: var(--gray-color-600);
}
@media screen and (min-width: 640px) {
......@@ -1403,6 +1345,7 @@ section.docs a:hover {
}
.footer .eclipse .copyright {
grid-column: span 2;
grid-row: 3;
padding-top: 0.25rem;
max-width: 80%;
......@@ -1701,16 +1644,18 @@ section.docs a:hover {
background: #5a6a81;
}
.to .listingblock.editor > .content {
scrollbar-color: #7dd3fc #1e293b;
.listingblock.editor > .content {
overscroll-behavior: none;
scrollbar-width: thin;
}
.from .listingblock.editor > .content {
scrollbar-color: #5a6a81 #a3acb8;
scrollbar-width: thin;
.to .listingblock.editor > .content {
scrollbar-color: #7dd3fc transparent;
}
.from .listingblock.editor > .content {
scrollbar-color: #5a6a81 transparent;
}
.editor-content > .tabset {
padding: 0;
......@@ -1763,6 +1708,8 @@ section.docs a:hover {
.editor .listingblock > .content code {
background-color: transparent;
line-height: 1.25rem;
scrollbar-color: #5a6a81 #a3acb8;
scrollbar-width: thin;
}
.editor .listingblock > .content code::-webkit-scrollbar {
......@@ -1774,11 +1721,6 @@ section.docs a:hover {
background: #5a6a81;
}
.editor .listingblock > .content code {
scrollbar-color: #5a6a81 #a3acb8;
scrollbar-width: thin;
}
.exampleblock.compare > .content {
display: flex;
gap: 1rem;
......
......@@ -3,7 +3,7 @@ layout: main
---
= AsciiDoc
:includedir@: ./examples
:tagline: Publish presentation-rich content written in a concise and comprehensive authoring format.
:tagline: Publish presentation-rich content written using a concise and comprehensive authoring format.
:description: AsciiDoc is a human-readable, text editor-friendly document format evolved from plain text markup conventions, yet semantically analogous to XML schemas like DocBook and DITA.
AsciiDoc is used to write notes, articles, documentation, books, web pages, slides, man pages, etc.
......@@ -35,7 +35,7 @@ image::./assets/img/intellij-asciidoc-editor.png[]
AsciiDoc provides all the semantic elements you need to write and publish technical books.
You'll also find AsciiDoc to be an ideal fit for documentation.
And yet, it's simple enough to use for READMEs or taking notes.
Explore the possibilities in the prepared screenshots.
Explore the possibilities by browsing these screenshots.
[.tab]
--
......@@ -88,9 +88,9 @@ image::./assets/img/man-page-git-for-each-ref.png[]
[#try-it-out.try]
== Try AsciiDoc now!: Experience the magic of a lightweight markup language
You write AsciiDoc using plain text.
That means most of what you type is what you want to communicate.
You only need to add markup characters when you want to encode meaning that can't be inferred.
When you write in AsciiDoc, you use plain text.
That means the bulk of what you type are the words you want to communicate.
You only add markup characters when you need to encode meaning that can't otherwise be inferred.
For example, a section title starts with a series of equals signs and an unordered list item begins with one or more asterisks.
[.attn]#Try writing AsciiDoc in the editor below to see for yourself!#
......@@ -115,8 +115,8 @@ puts 'Hello, World!'
[#compare.compare]
== How AsciiDoc stacks up: Compare AsciiDoc to other markup languages
AsciiDoc is designed to strike a balance between systematic, machine-oriented syntax and plain text with minimal markup.
This design affords AsciiDoc the ability to capture and encode nearly all the semantics of a structured language while still being readable in source form.
AsciiDoc is designed to strike a balance between systematic, machine-oriented syntax and natural language.
This design affords AsciiDoc the ability to capture and encode nearly all the semantics of a highly-structured language while still being readable in source form.
Want to see how AsciiDoc stacks up against alternatives?
Browse the sample documents in this section to compare.
......@@ -134,9 +134,7 @@ include::{includedir}/db-sample.xml[]
DocBook is an **XML schema** for writing books and manuals about technical subjects.
It has an extensive catalog of tags for denoting content structures and elements.
Although **well-supported by tools**,
writing in DocBook is tedious because the **content is overshadowed** by the markup,
there are **a lot of tags** to remember, and **XML indentation** can be a major distraction.
Although **well-supported by tools**, writing in DocBook is tedious because the **content is overshadowed** by the markup, there are **a lot of tags** to remember, and **XML indentation** can be a major distraction.
.index.adoc
[.editor,asciidoc]
......@@ -157,10 +155,7 @@ include::{includedir}/db-sample-chapter-2.adoc[]
------
**Content is the central focus** in AsciiDoc.
The document starts off with **no ceremonial prologue**,
much of the structure is inferred from its **line-oriented** arrangement,
there's **no indentation** needed, and instead of XML tags,
content is marked up with **shorthand notations**.
The document starts off with **no ceremonial prologue**, much of the structure is inferred from its **line-oriented** arrangement, there's **no indentation** needed, and, instead of XML tags, content is marked up with **shorthand notations**.
And yet, you can still produce DocBook from AsciiDoc to tie into existing toolchains.
--
......@@ -315,7 +310,7 @@ https://docs.asciidoctor.org[Explore,role=action]
[discrete]
=== Publish
Publish your content using static site generators and build tools that know how to work with AsciiDoc.
Publish your content using static site generators and build tools that understand how to work with AsciiDoc.
https://docs.asciidoctor.org[Explore,role=action]
--
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment