FFXIVITA Docs

Background

FFXIVITA Docs cerca di dare tutte le informazioni necessarie per un corretto uso e sviluppo di tutti i progetti che FFXIVITA Ha da offire.

Per questo proponianmo la documentazione per i nostri pòugin e anche per contribuire al loro sviluppo.

Applichiamo i più alti standard anche nello scrivere la documentazione in modo che sia di facile lettura e comprensione. Inoltre ogni singolo step è controllato da sviluppatori certificati in modo da tenere i più alti standard.

Come contribuire

Contatta lo staff di FFXIVITA

In caso di domande, suggerimenti o se vuoi contribuire al progetto docs, ti preghiamo di contattarci su Discord. - Discord

Tool Richiesti

Per partecipare al progetto docs, devi avere i seguenti tool installati:

Account GitHub e Git (Quickstart)
Python (Python Downloads)
Installa i seguenti pacchetti Python (vedi lista comandi sottostante):
MkDocs (MkDocs)
- mkdocs-awesome-pages-plugin
- mkdocs-git-revision-date-localized-plugin
- mkdocs-redirects
- mkdocs-embed-external-markdown
- mkdocs-video
- mike
- pillow
- cairosvg
Installa tutto con un singolo comando:
Esegui nel Terminal
```
pip install -r requirements.txt
```

Pillow + Cairo

Come parte di un nuovo metodo di condivisione social rilasciato con mkdocs-material 8.5.0 Pillow e Cairo Graphics sono stati aggiunti come dipendenze. Noi le mettiamo assieme come bundle dentro al nostro requirements.txt per assicurarsi di avere le dipendenze installate mentre si vuole provare localmente le social cards.

Editor / IDE:
- Raccomandato: Microsoft Visual Studio Code
  - plugin raccomandati per lavorare col Markdown:
    - qualsiasi plugin per il markdown - e.g. https://github.com/yzhang-gh/vscode-markdown
    - specifico per le tabelle: https://github.com/takumisoft68/vscode-markdown-table
- O qualunque JetBrains IDE, e.g. IntelliJ IDEA o PyCharm.

Informazioni Importanti

Per l'uso generale, non c'è bisogno per te di utilizzare questa feature localmente a meno che non si voglia cambiare delle impostazioni relative a questa feature.

Fare cambiamenti o aggiunte alla Documentazione

Forca il repository
Crea un nuovo branch basato sul branch "main" e dagli un nome corto e significativo.
Fai le tue modifiche sul tuo branch
Apri una pull Request
Aspetta un feedback da parte nostra e un merge

Last update: March 12, 2023