txtdot/dalet
1
0
Fork 0
mirror of https://github.com/TxtDot/dalet.git synced 2024-10-16 11:48:06 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: format concept

Browse source
This commit is contained in:
Artemy Egorov 2024-08-11 16:33:53 +03:00
parent b401c5dc9b
commit 6ad07ca0f9
1 changed files with 68 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

134
README.md
View file

@ -62,79 +62,81 @@ This is element
br br
# if no tag is specified but a '{- text}' is present, then the 'p' tag is placed # if no tag is specified but a '{- text}' is present, then the 'p' tag is placed
# '\n' is deleted in this format. If a break line is needed in a paragraph, use ' \n'. # '\n' is replaced with ' ' in this format.
{- {-
Check Dalet too Check Dalet too
This is one paragraph This is one paragraph
} }
{- This is another paragraph ({- text\}) } {-
This is another paragraph ({- text\})
}
row "center" [ row "center" [
link "https://github.com/txtdot/txtdot": Homepage link "https://github.com/txtdot/txtdot": Homepage
btn "https://example.com/donate" [ btn "https://example.com/donate" [
# tag without body # tag without body
img "https://example.com/donate.png" img "https://example.com/donate.png"
Donate Donate
] ]
] ]
# [] for multiple tags # [] for multiple tags
row [ row [
# if no tag is specified but a '[[]]' is present, then the 'el' tag # if no tag is specified but a '[[]]' is present, then the 'el' tag
# with multiple tags body placed # with multiple tags body placed
[[
h2: Features
ul [
Server-side page simplification
Media proxy
Image compression with Sharp
Rendering client-side apps `Vanilla, React, Vue, etc` with webder
Search with SearXNG
Handy API endpoints
No client JavaScript
Some kind of Material Design 3
Customization with plugins, see @txtdot/sdk and @txtdot/plugins
]
]]
[[
h2: Running
[[ [[
h3: Dev h2: Features
# {} for multiline strings, indent is automatically trimmed ul [
code { Server-side page simplification
npm install Media proxy
npm run dev Image compression with Sharp
} Rendering client-side apps `Vanilla, React, Vue, etc` with webder
Search with SearXNG
# {~n Text} n is number of minimum spaces Handy API endpoints
code "markdown" {~4 No client JavaScript
this is codeblock Some kind of Material Design 3
} Customization with plugins, see @txtdot/sdk and @txtdot/plugins
]
# {# Text} Text after "`# " not modified
code "markdown" {# this is codeblock}
]] ]]
[[ [[
h3: Production h2: Running
code {
npm install
npm run build
npm run start
}
]]
[[ [[
h3: Docker h3: Dev
code: docker compose up -d
]]
]] # {} for multiline strings, indent is automatically trimmed
code {
npm install
npm run dev
}
# {~n Text} n is number of minimum spaces
code "markdown" {~4
this is codeblock
}
# {# Text} Text after "`# " not modified
code "markdown" {# this is codeblock}
]]
[[
h3: Production
code {
npm install
npm run build
npm run start
}
]]
[[
h3: Docker
code: docker compose up -d
]]
]]
] ]
# Table has custom format if text used # Table has custom format if text used
@ -146,14 +148,14 @@ row [
# Description # Description
# ] # ]
table { table {
+| Tag | Description | +| Tag | Description |
| h | Heading | | h | Heading |
| p | Paragraph | | p | Paragraph |
| img | Image | | img | Image |
| link | Link | | link | Link |
| btn | Button | | btn | Button |
| ul | Unordered list | | ul | Unordered list |
| br | Line break | | br | Line break |
+| quantity | 7 | +| quantity | 7 |
} }
``` ```