Skip to content

Commit fc7dfe5

Browse files
re-organizing ui preview, tailwind improvements (#56)
* re-organizng ui preview, tailwind improvements * Update text formatting * Update lists * Update tabsets * Update code * Update admonitions * Update tables * Update images * Update blocks * Minor updates to elements pages * Update nav and titles; merge symbols * Update templates * Update vscode config * fix page icon attribute in preview, add icon docs * don't try to load the svg without content catalog --------- Co-authored-by: Eric Schneider <[email protected]>
1 parent 1669128 commit fc7dfe5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+2351
-2124
lines changed

.vscode/settings.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@
99
"emmet.syntaxProfiles": {
1010
"postcss": "css"
1111
},
12+
"asciidoc.antora.enableAntoraSupport": true,
1213
}

gulp.d/tasks/build-preview-pages.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@ module.exports = (src, previewSrc, previewDest, sink = () => map()) => (done) =>
4343
map((file, enc, next) => {
4444
const siteRootPath = path.relative(ospath.dirname(file.path), ospath.resolve(previewSrc))
4545
const uiModel = { ...baseUiModel }
46-
uiModel.page = { ...uiModel.page }
46+
uiModel.page = {
47+
...uiModel.page,
48+
url: path.join('/', path.relative(previewSrc, file.path.replace('.adoc', '.html'))),
49+
}
4750
uiModel.siteRootPath = siteRootPath
4851

4952
// The following has been customized to enable pull request preview builds on Github Pages.

package-lock.json

Lines changed: 110 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@
5454
"postcss-custom-properties": "~13.3",
5555
"postcss-import": "~15.1",
5656
"postcss-url": "~10.1",
57+
"prettier": "^3.1.0",
5758
"prettier-eslint": "~15.0",
59+
"prettier-plugin-tailwindcss": "^0.5.7",
5860
"require-directory": "~2.1",
5961
"require-from-string": "~2.0",
6062
"stylelint": "~13.3",

prettier.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
plugins: ['prettier-plugin-tailwindcss'],
3+
}
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
= Admonitions
2+
:idprefix:
3+
:idseparator: -
4+
:table-caption!:
5+
6+
== Basic admonitions
7+
8+
.Optional title
9+
[NOTE]
10+
====
11+
An admonition draws the reader's attention to auxiliary information.
12+
====
13+
14+
IMPORTANT: Sign off before stepping away from your computer.
15+
16+
TIP: Look for the warp zone under the bridge.
17+
18+
CAUTION: Slippery when wet.
19+
20+
WARNING: The software you're about to use is untested.
21+
22+
== Examples
23+
24+
=== Complex admonition
25+
26+
.The title of a complex admonition
27+
[NOTE]
28+
====
29+
An admonition block may contain complex content, like lists and tables.
30+
31+
.A list
32+
* List item
33+
** Nested list item
34+
*** Deeper nested list item
35+
* List item
36+
** Another nested list item
37+
* List item
38+
39+
.A table
40+
[cols="3*"]
41+
|===
42+
|Cell in column 1, row 1
43+
|Cell in column 2, row 1
44+
45+
|Cell in column 1, row 2
46+
|Cell in column 2, row 2
47+
48+
|Cell in column 1, row 3
49+
|Cell in column 2, row 3
50+
|===
51+
52+
.A code block
53+
[source,javascript]
54+
----
55+
vfs
56+
.src('js/vendor/*.js', { cwd: 'src', cwdbase: true, read: false })
57+
.pipe(tap((file) => { // <.>
58+
file.contents = browserify(file.relative, { basedir: 'src', detectGlobals: false }).bundle()
59+
}))
60+
----
61+
<.> Maybe with a callout.
62+
63+
.Another admonition
64+
[CAUTION]
65+
======
66+
Admonition styles are set on example blocks, which are delimited by four equal signs (`====`).
67+
When nesting a delimited block that uses the same structural container, it's necessary to vary the length of the delimiter lines (i.e., make the length of the delimiter lines for the child block different than the length of the delimiter lines for the parent block).
68+
Varying the delimiter line length allows the parser to distinguish one block from another.
69+
======
70+
====

0 commit comments

Comments
 (0)