From d5efb9f32c0f3c4cd5479c5f44dce55613f0a6e6 Mon Sep 17 00:00:00 2001 From: Timur Ismagilov Date: Fri, 30 Jul 2021 18:06:43 +0500 Subject: [PATCH] Document lists idk --- go.mod | 4 +- go.sum | 4 +- help/en/mycomarkup.myco | 99 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 103 insertions(+), 4 deletions(-) diff --git a/go.mod b/go.mod index 8d5b338..6926f83 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module github.com/bouncepaw/mycorrhiza go 1.16 require ( - github.com/bouncepaw/mycomarkup v0.5.8 + github.com/bouncepaw/mycomarkup v0.5.9 github.com/go-ini/ini v1.62.0 github.com/gorilla/feeds v1.1.1 github.com/gorilla/mux v1.8.0 @@ -16,4 +16,4 @@ require ( ) // Use this trick for testing of mycomarkup: -// replace github.com/bouncepaw/mycomarkup v0.5.7 => "/Users/bouncepaw/GolandProjects/mycomarkup" +// replace github.com/bouncepaw/mycomarkup v0.5.8 => "/Users/bouncepaw/GolandProjects/mycomarkup" diff --git a/go.sum b/go.sum index 33434bc..331ce6a 100644 --- a/go.sum +++ b/go.sum @@ -1,6 +1,6 @@ github.com/andybalholm/brotli v1.0.0/go.mod h1:loMXtMfwqflxFJPmdbJO0a3KNoPuLBgiu3qAvBg8x/Y= -github.com/bouncepaw/mycomarkup v0.5.8 h1:VV0l9h1JfLourRshj6hh49OJyG1Ar6lnFW2XXYjyoyI= -github.com/bouncepaw/mycomarkup v0.5.8/go.mod h1:0n6thlGGgrx2Y/2NaaUH4qHW4v1xJ+EpW7yMFUxNRIg= +github.com/bouncepaw/mycomarkup v0.5.9 h1:yzGP4fPxblEwY96BLiyVIuIr+eTMplcDOkWMt3bajuQ= +github.com/bouncepaw/mycomarkup v0.5.9/go.mod h1:0n6thlGGgrx2Y/2NaaUH4qHW4v1xJ+EpW7yMFUxNRIg= github.com/go-ini/ini v1.62.0 h1:7VJT/ZXjzqSrvtraFp4ONq80hTcRQth1c9ZnQ3uNQvU= github.com/go-ini/ini v1.62.0/go.mod h1:ByCAeIL28uOIIG0E3PJtZPDL8WnHpFKFOtgjp+3Ies8= github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGaHF6qqu48+N2wcFQ5qg5FXgOdqsJ5d8= diff --git a/help/en/mycomarkup.myco b/help/en/mycomarkup.myco index 5dab079..c7035e2 100644 --- a/help/en/mycomarkup.myco +++ b/help/en/mycomarkup.myco @@ -10,6 +10,8 @@ A Mycomarkup document (which is most often a hypha's text part) consists of //bl => /help/en/mycomarkup#Heading Heading => /help/en/mycomarkup#Codeblock Codeblock => /help/en/mycomarkup#Horizontal_line Horizontal line +=> /help/en/mycomarkup#Image_gallery Image gallery +=> /help/en/mycomarkup#List List ## Paragraph **Paragraphs** are the most ubiquitous blocks. You will use them a lot. @@ -97,5 +99,102 @@ Write four hyphens to insert a **horizontal line**. ```} * ---- +## Image gallery +Use **image galleries** to embed images to the page. Images can be either hyphae or external files. In the example below you can replace the URL with a hypha's name. If that hypha is an image, the image will be shown. + +You can write a description for the image and specify its size. + +* {``` +img { +https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg +https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg { + Description //here// +} +https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 100 { Size } +https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 50*50 +} +```} +* { +img { +https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg +https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg { + Description //here// +} +https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 100 { Size } +https://upload.wikimedia.org/wikipedia/commons/4/48/Timbre_ciuperci_otravitoare.jpg | 50*50 { Square } +} +} + +If you were embedding a hypha called //an image hypha//, it would look like this: +* {``` +img { +an image hypha +} +```} + +If you put just one image, it will be displayed with no decorations: +* {``` +img { https://mycorrhiza.wiki/static/favicon.ico } +```} +* {img { https://mycorrhiza.wiki/static/favicon.ico }} + +## List +**Lists** are used for sequential or tree data. They are quite popular. + +Mark each list entry with an asterisk and a space: +* {``` +* one +* two +* three +```} +* { +* one +* two +* three +} + +If you place dots after the asterisks, the list becomes numbered: +* {``` +*. one +*. two +*. three +```} +* { +*. one +*. two +*. three +} + +If you place `x` or `v`, you make the entries unfinished and finished T\ODO entries respectively. +* {``` +*v Done +*x Not done +**v Super done +** Cool +```} +* { +*v Done +*x Not done +**v Super done +** Cool +} + +All of Mycomarkup is supported in list entries. If you want to have multi-line entries, wrap the contents in curly braces. + +* {``` +* { +## Heading +Text +} +* Not multiline +```} +* { +* { +## Heading +Text +} +* Not multiline +} + ## See also => https://mycorrhiza.wiki/hypha/essay/why_mycomarkup Why it was created \ No newline at end of file