diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..979fbf43 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Domande + url: https://github.com/opendatasicilia/ods-mkdocs-material/discussions + about: Per favore fai qui le tue domande su Material for MkDocs. Se invece devi segnalare un problema o fare una proposta per il codice di questo repo, apri una issue (qui sotto il link "Open a blank issue"). diff --git a/.github/workflows/gh-deploy.yml b/.github/workflows/gh-deploy.yml index 4814185b..953702c2 100644 --- a/.github/workflows/gh-deploy.yml +++ b/.github/workflows/gh-deploy.yml @@ -1,10 +1,11 @@ -name: gh-deploy - +name: gh-deploy on: push: - branches: + branches: - main + paths: + - 'docs/**' workflow_dispatch: jobs: @@ -19,26 +20,26 @@ jobs: - run: pip install mkdocs-material-extensions>=1.0 - run: pip install mkdocs>=1.2.2 - run: pip install markdown>=3.2 - - run: pip install requests_oauthlib - - run: pip install click - - run: pip install click-plugins - - run: pip install click-config-file - - run: pip install pytest - - run: pip install mkdocs - - run: pip install mkdocstrings +# - run: pip install requests_oauthlib +# - run: pip install click +# - run: pip install click-plugins +# - run: pip install click-config-file +# - run: pip install pytest +# - run: pip install mkdocs +# - run: pip install mkdocstrings - run: pip install mkdocs-click - run: pip install Pygments>=2.4 - run: pip install pymdown-extensions>=9.0 - - run: pip install mkdocs-autolinks-plugin - - run: pip install mkdocs-jupyter - - run: pip install mkdocs-exclude - - run: pip install mkdocs-exclude-search - - run: pip install mkdocs-macros-plugin - - run: pip install mkdocs-print-site-plugin - - run: pip install mkdocs-pdf-export-plugin - - run: pip install mkdocs-git-revision-date-localized-plugin - - run: pip install mkdocs-windmill - - run: pip install mkdocs-img2fig-plugin +# - run: pip install mkdocs-autolinks-plugin +# - run: pip install mkdocs-jupyter +# - run: pip install mkdocs-exclude +# - run: pip install mkdocs-exclude-search +# - run: pip install mkdocs-macros-plugin +# - run: pip install mkdocs-print-site-plugin +# - run: pip install mkdocs-pdf-export-plugin +# - run: pip install mkdocs-git-revision-date-localized-plugin +# - run: pip install mkdocs-windmill +# - run: pip install mkdocs-img2fig-plugin - run: pip install mkdocs-rss-plugin - run: pip install mkdocs-mermaid2-plugin - - run: mkdocs gh-deploy --force + - run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/README.md b/README.md index 23ed8138..cabda614 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ Questo è un repository per ospitare una guida all'utilizzo di **Material for Mk - [MkDocs](https://www.mkdocs.org/) è uno strumento per creare siti web di documentazione, guide, manuali, ecc.; - [Material](https://squidfunk.github.io/mkdocs-material/) è un tema per personalizzare siti basati su MkDocs. - Questa guida è raggiungibile [qui](https://opendatasicilia.github.io/ods-mkdocs-material/), ed è generata tramite [questa GitHub Action](https://github.com/opendatasicilia/ods-mkdocs-material/blob/main/.github/workflows/gh-deploy.yml) ([qui](https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions) la guida correlata). ![GitHub issues](https://img.shields.io/github/issues/opendatasicilia/ods-mkdocs-material?color=blue) diff --git a/docs/Configurazione/conf1.md b/docs/Configurazione/conf1.md deleted file mode 100644 index e4cfd71f..00000000 --- a/docs/Configurazione/conf1.md +++ /dev/null @@ -1,19 +0,0 @@ -# Titolo 1 - -## Mauris augue tellus -![](../img/logo.png){ align=left} iaculis a vulputate vel, aliquet ac tortor. Praesent ac metus cursus, tristique orci id, tincidunt massa. Praesent condimentum lacus sed mattis bibendum. Vestibulum et aliquet felis, ac faucibus turpis. Duis condimentum semper dolor dictum molestie. Nulla leo orci, varius et odio ut, fringilla dapibus metus. Vestibulum ac mi ex. Cras convallis gravida ipsum vel egestas. - -Nulla condimentum porttitor turpis, in interdum ligula finibus dapibus. Cras ut lorem porta enim commodo pharetra. Morbi quis arcu vitae leo imperdiet eleifend non a tellus. Donec sagittis fringilla ipsum pretium pulvinar. Suspendisse gravida molestie ultrices. Pellentesque imperdiet at arcu viverra mattis. Morbi vitae nisl vitae purus cursus posuere sit amet et leo. - - -## Nunc bibendum -dolor vitae molestie sodales. Nam fringilla luctus diam. Vestibulum volutpat urna at lectus bibendum consequat. Sed cursus pellentesque nisl in ultrices. Vestibulum dictum lectus a pretium volutpat. Curabitur iaculis vel tellus sit amet placerat. Cras a rutrum lorem. Cras rutrum leo in sapien euismod egestas. Sed leo sapien, placerat ac ex eu, gravida sodales augue. Vestibulum malesuada pellentesque nisl, et pretium tellus varius pulvinar. Nullam vel lacus vitae dolor hendrerit eleifend. Quisque tempus nulla in augue ullamcorper, ac vulputate felis pulvinar. Pellentesque est nisi, gravida ornare aliquam eu, dapibus sit amet sem. - -### Quisque -sed ultricies felis, quis auctor est. Integer odio metus, porttitor sit amet finibus id, tempor quis dolor. Etiam id laoreet nisl. Quisque volutpat erat metus, vitae sagittis ex pellentesque a. Nulla tristique purus non sem iaculis vehicula. Integer hendrerit sapien non orci imperdiet, at sodales lectus molestie. Sed sodales leo eu posuere lacinia. Etiam a accumsan magna. Integer sodales vulputate orci. In viverra mi eu lectus malesuada, elementum vehicula dui posuere. Nunc mauris nibh, vehicula quis sodales ut, pulvinar at mi. Nullam at varius ipsum, in tristique lorem. Vivamus lobortis magna nec magna tincidunt, sit amet sagittis leo auctor. - -Aliquam a tellus vitae odio accumsan aliquam. Nam ex elit, aliquam id tortor at, mattis pretium enim. Donec elementum libero et turpis tempus venenatis. Nulla ut risus mollis, elementum quam sed, mattis mauris. Pellentesque sit amet orci nulla. Curabitur interdum nisl id ex dapibus, consequat tempus metus interdum. In porta scelerisque ex et dictum. Morbi vitae tincidunt mauris. Ut luctus vulputate odio eget iaculis. Phasellus eget nisi eget orci scelerisque ullamcorper. Donec convallis rutrum neque, et eleifend lacus fermentum fermentum. Quisque nec quam sit amet mi dapibus mattis at in arcu. Suspendisse potenti. -![](../img/card_social_site.png) - -## Orci varius -natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nam sed euismod enim. Phasellus in aliquet erat. Quisque eget erat varius, gravida leo eget, malesuada enim. Sed cursus bibendum porta. Mauris tincidunt facilisis arcu vel dignissim. Curabitur aliquam risus ac malesuada ultricies. Etiam tincidunt libero sit amet elit tempor rhoncus. Donec elit est, pharetra et purus sed, euismod vehicula eros. diff --git a/docs/Configurazione/conf2.md b/docs/Configurazione/conf2.md deleted file mode 100644 index 1a1067c9..00000000 --- a/docs/Configurazione/conf2.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -social_image: img/card_social_page.png ---- - -# Titolo 1 - -## Nunc aliquam -ultricies pulvinar. Aliquam dignissim dolor non dui mattis, at commodo mauris imperdiet. Aenean sed mauris at purus commodo ultricies. In cursus felis lacus, in aliquam ipsum porttitor quis. Suspendisse vel eleifend purus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Duis maximus volutpat orci. Maecenas at metus in turpis placerat iaculis. Fusce at egestas tellus. Maecenas lacinia leo neque, sit amet aliquam ex interdum sed. Vestibulum elit sapien, egestas eget volutpat in, interdum sit amet velit. -![](../img/gatti.jpg) -Proin varius mattis est, eget imperdiet leo tristique et. Pellentesque aliquam libero eu felis scelerisque, et tincidunt libero iaculis. Morbi vehicula magna a metus interdum, eget consequat enim euismod. Proin sed nisl eros. Vestibulum id pretium elit. Aenean id lacus pellentesque, commodo ipsum at, auctor enim. Aliquam erat volutpat. Nam facilisis feugiat turpis ut sagittis. Praesent porttitor turpis ac ex luctus aliquet ac eu ante. Nunc dignissim vehicula mi. - -### Cras risus nunc -fringilla vel risus non, feugiat varius erat. Suspendisse ultrices consectetur lorem quis feugiat. Vestibulum varius lacus laoreet mollis ultrices. Vestibulum non augue eu libero lacinia porttitor. Nunc pellentesque lobortis erat, vitae egestas elit egestas eget. Curabitur euismod arcu sed diam ultricies, vel suscipit erat tincidunt. Aenean fermentum elementum aliquam. Nulla molestie risus turpis, vitae mattis neque fringilla eu. Praesent sit amet dictum leo. Donec eu maximus ex. - -## Suspendisse -non cursus urna, vitae suscipit ante. Cras nulla felis, rutrum non blandit eu, imperdiet in ante. Nunc iaculis felis in mi bibendum, eu aliquet risus blandit. Proin commodo velit lectus, non dignissim augue finibus non. Vestibulum consequat metus enim, vel porttitor diam sollicitudin ac. Aliquam erat volutpat. Etiam placerat et purus in elementum. Nam mollis nibh in pretium commodo. Integer in metus ut ex tincidunt euismod ac vitae turpis. Duis cursus lacus velit, eu laoreet tellus venenatis in. Suspendisse eleifend hendrerit interdum. Aenean sodales laoreet ligula. Nam id commodo est. Donec finibus felis velit, vitae fermentum neque porttitor id. In consectetur tempus odio quis porta. - -![](../img/gatto.jpg) - -Suspendisse potenti. Sed eu commodo purus. Fusce vitae auctor purus. Fusce nulla lectus, lobortis nec scelerisque sit amet, auctor in elit. Donec ut nisi quis urna dictum dictum eu nec dolor. Nam eget convallis est, eget maximus dolor. Donec varius laoreet ultricies. Integer id consequat ex. Pellentesque mi elit, interdum nec lectus eu, vestibulum semper ipsum. Aenean et dolor accumsan, placerat turpis a, eleifend dui. Vestibulum justo metus, vestibulum et viverra lacinia, tristique rhoncus tortor. \ No newline at end of file diff --git a/docs/Configurazione/index.md b/docs/Configurazione/index.md index 8025117a..25dfa58b 100644 --- a/docs/Configurazione/index.md +++ b/docs/Configurazione/index.md @@ -4,6 +4,9 @@ hide: --- # Configurazione + +## Combinazioni colori + Material per MkDocs supporta due combinazioni di colori: una modalità chiara, chiamata semplicemente `default`, e una modalità scura, chiamata `slate`. Lo schema dei colori può essere impostato nel file `mkdocs.yml`: ``` theme: @@ -33,7 +36,6 @@ theme: accent: indigo ``` - ## Dominio personalizzato
da completare .....
diff --git a/docs/Installazione/insta2_2.md b/docs/Installazione/index.md similarity index 97% rename from docs/Installazione/insta2_2.md rename to docs/Installazione/index.md index d4bce55a..73008b30 100644 --- a/docs/Installazione/insta2_2.md +++ b/docs/Installazione/index.md @@ -1,8 +1,11 @@ --- social_image: img/card_social_page.png +hide: + - navigation --- -# Titolo 2.2 + +# Istallazione ## eros malesuada et eleifend mi bibendum. Nunc ligula orci, aliquam vitae faucibus at, rhoncus vel risus. In sagittis gravida placerat. Sed gravida egestas leo, in accumsan neque sagittis quis. Curabitur vehicula velit ac sem rhoncus pulvinar. Vestibulum quis cursus ex. @@ -19,4 +22,4 @@ feugiat ipsum ut, sodales arcu. Curabitur sagittis, justo eget lobortis fringill faucibus dui a venenatis. Morbi consequat elit ac vestibulum tempus. Aliquam eleifend porta leo, in accumsan nulla venenatis at. Curabitur eget felis lectus. Duis quis porta urna, a mollis ex. Quisque faucibus maximus volutpat. Donec volutpat lorem quis est dignissim malesuada. Cras ultricies leo metus, in accumsan lectus blandit porttitor. Vivamus hendrerit auctor odio non accumsan. Aliquam non augue sit amet est luctus mattis ut sit amet enim. Donec id orci luctus, consequat libero eget, mollis diam. ### Integer pellentesque -tellus in libero gravida, sed maximus mi imperdiet. Duis sed volutpat purus, ut fringilla ex. Sed mollis risus sit amet dolor congue condimentum. Nullam porttitor quam ac ex vehicula, quis maximus turpis auctor. Nulla id rhoncus libero. Donec quis dolor ultrices, fringilla dui venenatis, tempor est. Etiam maximus justo eget dignissim gravida. \ No newline at end of file +tellus in libero gravida, sed maximus mi imperdiet. Duis sed volutpat purus, ut fringilla ex. Sed mollis risus sit amet dolor congue condimentum. Nullam porttitor quam ac ex vehicula, quis maximus turpis auctor. Nulla id rhoncus libero. Donec quis dolor ultrices, fringilla dui venenatis, tempor est. Etiam maximus justo eget dignissim gravida. diff --git a/docs/Installazione/insta1.md b/docs/Installazione/insta1.md deleted file mode 100644 index ca045c1c..00000000 --- a/docs/Installazione/insta1.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -social_image: img/card_social_page.png ---- - -# Lorem Ipsum - -## What is Lorem Ipsum? -Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's ![](../img/gatti_02.jpg){ align=right}standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum. - -### Why do we use it? -It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. ![](../img/gatti_02.jpg){ align=left} The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like). - - -## Where does it come from? -Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32. - -![](../img/gatti_02.jpg) - -The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham - -### Where can I get some? -There are many variations of passages of Lorem Ipsum available, ![](../img/gatti.jpg){ align=left} but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc. \ No newline at end of file diff --git a/docs/Installazione/insta2_1.md b/docs/Installazione/insta2_1.md deleted file mode 100644 index 80dbf656..00000000 --- a/docs/Installazione/insta2_1.md +++ /dev/null @@ -1,11 +0,0 @@ -# Titolo 2.1 - -## Lorem ipsum dolor sit amet - -Consectetur adipiscing elit. Vestibulum molestie lacinia tortor at elementum. Donec luctus luctus ornare. Sed eget lorem et quam ultrices eleifend vel vitae quam. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed pulvinar mollis euismod. Donec tempor sollicitudin dui, a venenatis diam suscipit sit amet. Donec vel dolor nunc. Mauris lobortis nec dolor vel ultrices. Donec ac lectus nec mi sagittis consectetur ac nec est. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Aliquam non neque fringilla, tristique mauris in, scelerisque ipsum. Fusce pellentesque orci dolor, sagittis vestibulum tortor lacinia in. Donec vestibulum turpis eu maximus bibendum. Pellentesque vulputate in lectus sed lacinia. Maecenas fringilla metus metus, at accumsan ex sollicitudin non. -![](../img/gatti.jpg) -## Sed vel augue nisl. -Nunc tristique odio non dolor luctus, ultricies scelerisque enim sollicitudin. Donec bibendum, erat a pulvinar ultricies, ipsum felis ultrices odio, at consectetur metus nisi vitae ante. Vestibulum eu metus laoreet purus pulvinar pellentesque. Phasellus nulla dui, scelerisque ut magna sed, dignissim cursus odio. Proin in sapien nec augue pulvinar rhoncus sed a elit. Duis ex justo, fermentum nec dui ut, auctor volutpat mauris. Vivamus at interdum massa. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. - -vestibulum turpis eu maximus bibendum. Pellentesque vulputate in lectus sed lacinia. Maecenas fringilla metus metus, at accumsan ex sollicitudin non. -![](../img/gatto.jpg) \ No newline at end of file diff --git a/docs/Installazione/insta3.md b/docs/Installazione/insta3.md deleted file mode 100644 index 7470a8ab..00000000 --- a/docs/Installazione/insta3.md +++ /dev/null @@ -1,15 +0,0 @@ -# Titolo 3 - -## Class aptent taciti -sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. ![](../img/gatto.jpg){ align=right}Duis iaculis tellus et quam commodo, a bibendum nibh maximus. Sed sapien orci, volutpat vehicula turpis sed, egestas hendrerit libero. Maecenas tempor quam erat, sit amet scelerisque mi iaculis sed. Pellentesque tortor elit, tincidunt non velit vitae, iaculis pulvinar est. Nullam ac mattis mi, sit amet finibus tellus. Nam id erat dapibus, rhoncus eros et, venenatis enim. Morbi quis rutrum velit. Maecenas in convallis mauris. Mauris malesuada lacus quis interdum convallis. Donec eget ligula maximus, tincidunt nunc quis, tincidunt ante. Maecenas placerat ut urna a rhoncus. In sollicitudin tortor magna, tincidunt fringilla mi rhoncus ac. - -### Pellentesque -sit amet rhoncus ipsum. Praesent dictum odio non tellus![](../img/gatti.jpg){ align=left} faucibus suscipit. Quisque sit amet euismod mauris. Nulla facilisi. Donec porta felis sed maximus scelerisque. Donec maximus nunc diam, a aliquet mauris pharetra vitae. Donec ac dui cursus, euismod turpis vel, egestas arcu. Nulla elementum ipsum sem, eget faucibus odio laoreet ac. Donec vulputate maximus libero, sed mattis enim laoreet vel. Nam eget arcu sagittis, semper dui sit amet, vehicula augue. Aenean placerat porta finibus. Nullam vitae ornare tortor. - -## Nunc aliquam -ultricies pulvinar. Aliquam dignissim dolor non dui mattis, at commodo mauris imperdiet. ![](../img/gatti.jpg){ align=left} Aenean sed mauris at purus commodo ultricies. In cursus felis lacus, in aliquam ipsum porttitor quis. Suspendisse vel eleifend purus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Duis maximus volutpat orci. Maecenas at metus in turpis placerat iaculis. Fusce at egestas tellus. Maecenas lacinia leo neque, sit amet aliquam ex interdum sed. Vestibulum elit sapien, egestas eget volutpat in, interdum sit amet velit. - -## Proin varius -mattis est, eget imperdiet leo tristique et. Pellentesque aliquam libero ![](../img/gatti_02.jpg){ align=left} eu felis scelerisque, et tincidunt libero iaculis. Morbi vehicula magna a metus interdum, eget consequat enim euismod. Proin sed nisl eros. Vestibulum id pretium elit. Aenean id lacus pellentesque, commodo ipsum at, auctor enim. Aliquam erat volutpat. Nam facilisis feugiat turpis ut sagittis. Praesent porttitor turpis ac ex luctus aliquet ac eu ante. Nunc dignissim vehicula mi. - -![](../img/404.gif) \ No newline at end of file diff --git a/docs/Ricette/index.md b/docs/Ricette/index.md index 6cbe7030..56c1f049 100644 --- a/docs/Ricette/index.md +++ b/docs/Ricette/index.md @@ -171,9 +171,9 @@ markdown_extensions: ``` theme: features: - - content.code.annotate + - content.code.annotate ``` - + Vediamo qual è il risultato. Inseriamo nel seguente blocco di codice un commento che sarà preceduto dal simbolo cancelletto `#` e dal numero dentro parentesi tonda. Dopo aver chiuso il blocco di codice lasciare una riga vuota e inserire il commento: ```` markdown @@ -197,3 +197,37 @@ theme: 1. :man_raising_hand: I'm a code annotation! I can contain `code`, __formatted text__, images, ... basically anything that can be expressed in Markdown. + + +## Come inserire in blocchi di codice sintassi Jinja + +`Jinja` è il motore dei [template/temi di MkDocs](https://www.mkdocs.org/dev-guide/themes/). `Material` non usa di base `Jinja`, salvo che non sia caricato da qualche estensione, come la [`macros`](https://github.com/fralau/mkdocs_macros_plugin).