mirrors/mycorrhiza
1
0
Fork 0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2024-12-12 05:20:26 +00:00
Code Issues Releases Wiki Activity

Help: Update Mycomarkup doc

Browse Source 
New rocket link syntax and new img layout
This commit is contained in:
Timur Ismagilov 2022-01-27 16:29:59 +05:00
parent 4180e8c853
commit 2db10a2e7e
1 changed files with 20 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
help/en/mycomarkup.myco
View File

@ -6,17 +6,17 @@ It is the only supported markup, there is no support for Markdown, Creole, etc.
A Mycomarkup document (which is most often a hypha's text part) consists of //blocks//. There are different blocks for different purposes. A Mycomarkup document (which is most often a hypha's text part) consists of //blocks//. There are different blocks for different purposes.
== Table of contents == Table of contents
=> /help/en/mycomarkup#Paragraph Paragraph => /help/en/mycomarkup#Paragraph | Paragraph
=> /help/en/mycomarkup#Inline_link Inline link => /help/en/mycomarkup#Inline_link | Inline link
=> /help/en/mycomarkup#Rocket_link Rocket link => /help/en/mycomarkup#Rocket_link | Rocket link
=> /help/en/mycomarkup#Heading Heading => /help/en/mycomarkup#Heading | Heading
=> /help/en/mycomarkup#Codeblock Codeblock => /help/en/mycomarkup#Codeblock | Codeblock
=> /help/en/mycomarkup#Horizontal_line Horizontal line => /help/en/mycomarkup#Horizontal_line | Horizontal line
=> /help/en/mycomarkup#Image_gallery Image gallery => /help/en/mycomarkup#Image_gallery | Image gallery
=> /help/en/mycomarkup#List List => /help/en/mycomarkup#List | List
=> /help/en/mycomarkup#Quote Quote => /help/en/mycomarkup#Quote | Quote
=> /help/en/mycomarkup#Table Table => /help/en/mycomarkup#Table | Table
=> /help/en/mycomarkup#Transclusion Transclusion => /help/en/mycomarkup#Transclusion | Transclusion
== Paragraph == Paragraph
**Paragraphs** are the most ubiquitous blocks. You will use them a lot. **Paragraphs** are the most ubiquitous blocks. You will use them a lot.
@ -95,15 +95,15 @@ The display text is written after the first space, not `|`. If you want to link
* {``` * {```
=> hypha => hypha
=> hypha_with_spaces => hypha with spaces
=> https://example.org => https://example.org
=> https://example.org Display text => https://example.org | Display text
```} ```}
* { * {
=> hypha => hypha
=> hypha_with_spaces => hypha with spaces
=> https://example.org => https://example.org
=> https://example.org Display text => https://example.org | Display text
} }
=== Relative link addressing === Relative link addressing
@ -199,17 +199,11 @@ img { https://mycorrhiza.wiki/static/favicon.ico }
=== Gallery layout === Gallery layout
A **gallery layout** consists of two things: position and arrangement. Set **gallery layout** to specify how your gallery is placed.
* **Position** is about how the gallery is placed in the document. There are three possible positions, listed below. Note that they matter only on big screens. There is no difference on a phone. There are three layouts: `normal` (the default), `grid` and `side`.
** `end` places the gallery at the end of line. By default, it is the right of the line. The text is wrapped around it.
** `start` does the same thing, but places the gallery at the start, i/e left side.
** `stretch` is the default position: the gallery is stretched to fit the document horizontally.
* **Arrangement** is about how the images are placed in the gallery. There are two possible arrangements:
** `grid` places the images in a grid.
** `column` is the default arrangement: the images are in a vertical column.
Specify the layout after `img` and before `{`. Just write the position and arrangement you need. If you do not write any of them, the default value will be used. Specify the layout after `img` and before `{`. If you do not write any of them, `normal` will be used.
``` ```
img grid { img grid {
@ -217,7 +211,7 @@ img grid {
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg
} }
img start column { img side {
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200 https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200 https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200
} }
@ -229,7 +223,7 @@ img grid {
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg
} }
img start column { img side {
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200 https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200
https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200 https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 200
} }