Formatowanie
Artykuł zawiera informacje o formatowaniu tekstu niniejszej strony i służy jako instrukcja wprowadzania do niej treści.
Jak edytować poszczególne artykuły¶
Historia zmian¶
Wpis przypomina standardowe notatki z sesji w repozytorium:
### data, tytuł, osoba dokonująca zmiany
*Pliki: lista plików, relatywnie do folderu `Nerthus` w repoytorium*
Opis zmiany
W tworzeniu opisu pomocne może być content tabs.
Konfiguracja¶
Plik mkdocs.yml (dostęp wyłącznie dla osób posiadających uprawnienia do przeglądania i edytowania repozytorium) zawiera informacje na podstawie których generowana jest strona Nerthusa i wszystkie jej podstrony.
Nawigacja¶
Edytorów Wiki powinna interesować treść właściwości nav w pliku .robot/mkdocs.yml, określająca strukturę strony i panel nawigacyjny po jej lewej stronie.
nav:
- 'Start': index.md
- 'Informacje':
- 'Kontakt': 'Informacje/Kontakt.md'
- 'Narratorzy': 'Informacje/Narratorzy.md'
- 'Dodatki': 'Informacje/Dodatki.md'
- 'Historia zmian': 'Informacje/Historia zmian.md'
- 'Świat gry':
- 'Wieści z krainy': 'Świat gry/Wieści z krainy.md'
- 'Mechanika':
- 'Tworzenie i rozwój postaci': 'Mechanika/Tworzenie i rozwój postaci.md'
- 'System Umiejętności': 'Mechanika/System Umiejętności.md'
- 'System Magii':
- 'System Magii': 'Mechanika/System Magii/System Magii.md'
- 'Rdzeń Kosmosu': 'Mechanika/System Magii/Rdzeń Kosmosu.md'
- 'Kamienie': 'Mechanika/Kamienie.md'
Rozszerzenia¶
Dodatkowe rozszerzenia, wykraczające poza standardowy zestaw GitLaba, są określane we właściwości markdown_extensions w pliku .robot/mkdocs.yml:
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.critic
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
Poniżej opisane jest działanie wybranych rozszerzeń.
Admonitions¶
Objaśnienia, które można stosować w artykułach jako tekst pomocniczy.
Przykład:
!!! Objaśnienie
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Efekt:
Objaśnienie
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Content tabs¶
Tabele, które można przełączać między różnymi opcjami.
Przykład:
=== "Fragment używany do demonstracji tekstu"
> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
> Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
> Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
> Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
=== "Fragment wersji oryginalnej"
> Sed ut perspiciatis, unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam eaque ipsa, quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt, explicabo.
> Nemo enim ipsam voluptatem, quia voluptas sit, aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos, qui ratione voluptatem sequi nesciunt, neque porro quisquam est, qui dolorem ipsum, quia dolor sit, amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt, ut labore et dolore magnam aliquam quaerat voluptatem.
> Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur?
> Quis autem vel eum iure reprehenderit, qui in ea voluptate velit esse, quam nihil molestiae consequatur, vel illum, qui dolorem eum fugiat, quo voluptas nulla pariatur?
Efekt:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Sed ut perspiciatis, unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam eaque ipsa, quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt, explicabo. Nemo enim ipsam voluptatem, quia voluptas sit, aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos, qui ratione voluptatem sequi nesciunt, neque porro quisquam est, qui dolorem ipsum, quia dolor sit, amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt, ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit, qui in ea voluptate velit esse, quam nihil molestiae consequatur, vel illum, qui dolorem eum fugiat, quo voluptas nulla pariatur?
Buttons¶
Umożliwia wstawianie przycisków wewnątrz artykułu.
Przykład:
[Zajrzyj na nasz dział na forum!](https://forum.margonem.pl/?task=forum&show=topics&id=33){ .md-button .md-button--primary }
Efekt: