Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Impossibile visualizzare il template di mkdocs in GitHub Pages #188

Open
Heryx opened this issue Sep 19, 2021 · 10 comments
Open

Impossibile visualizzare il template di mkdocs in GitHub Pages #188

Heryx opened this issue Sep 19, 2021 · 10 comments

Comments

@Heryx
Copy link
Contributor

Heryx commented Sep 19, 2021

Salve a tutti,
sto provando a creare una pagina usando mkdocs. Ho creato il repo e la pagina con GitHub Pages, ma non so per quale strano motivo non mi carica più il template di mkdocs. Attualmente al link visualizzo la pagina index.md ma senza la possibilità di fare nient'altro.
Qualche consiglio o aiuto?

Grazie in anticipo,
Giuseppe

@cirospat
Copy link
Contributor

cirospat commented Sep 20, 2021 via email

@Heryx
Copy link
Contributor Author

Heryx commented Sep 20, 2021

Ciao Giuseppe Mostra il link del repo GitHub del tuo progetto. Hai clonato qualche tepo già esistente? Il lun 20 set 2021, 00:21 Giuseppe Guarino @.***> ha scritto:

Salve a tutti, sto provando a creare una pagina usando mkdocs. Ho creato il repo e la pagina con GitHub Pages, ma non so per quale strano motivo non mi carica più il template di mkdocs. Attualmente al link visualizzo la pagina index.md ma senza la possibilità di fare nient'altro. Qualche consiglio o aiuto? Grazie in anticipo, Giuseppe — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#188>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA4VLVOL7OEJYEKQXBOKSD3UCZO7DANCNFSM5EKZDOQQ .

Buongiorno, ho utilizzato il classico template chiamato readthedocs. Ecco il repo https://github.com/Heryx/quantumfield.io
Vi do più dettagli. La struttura della cartella root/ è costituita da doc/, site/ mkdocs.myl e Readme.md. In github pages Punto alla cartella doc/ dove all'interno ci sono tutte le pagine da me create compreso un index.md.

@gbvitrano
Copy link
Member

Buongiorno, mi sfugge un particolare, se hai usato un template readthedocs perché le pagine html sono dentro la cartella site all'interno del repo?

Vuoi fare il render delle pagine direttamente su github o su readthedocs ?
in entrambi i casi mancano i file di configurazione oltre a mkdocs.yml devi anche inerire .readthedocs.yaml (se vuoi usare RTD come motore di rendering) e requirements-mkdocs.txt
Hai creato un progetto su https://readthedocs.org/...?
Per generare gh-pages in automatico ad ogni modifica devi creare un actions

Se vuoi realizzare una guida puoi clonare un nostro repo che usiamo come base, devi solo personalizzarlo, l'actions per le gh-pages inclusa :-)
E' sempre mkdocs ma con tema Material for MkDocs

@Heryx
Copy link
Contributor Author

Heryx commented Sep 20, 2021

Il perché stiano dentro la cartella site non saprei, ho seguito la guida dal sito di mkdocs e ho lavorato da terminale dando il comando mkdocs build per costruire la cartella site.
Comunque se c'è già il vostro repo bello pronto userò quello :). Per cambiare eventualmente il tema è importante quindi che ci siamo quindi i file di configurazione, ma dovrò farlo manualmente.

@gbvitrano
Copy link
Member

Il perché stiano dentro la cartella site non saprei, ho seguito la guida dal sito di mkdocs e ho lavorato da terminale dando il comando mkdocs build per costruire la cartella site.
Comunque se c'è già il vostro repo bello pronto userò quello :). Per cambiare eventualmente il tema è importante quindi che ci siamo quindi i file di configurazione, ma dovrò farlo manualmente.

Nelle impostazioni delle gh-pages hai selezionato il percorso giusto? Punta alla cartella site?

@Heryx
Copy link
Contributor Author

Heryx commented Sep 20, 2021

Volevo che puntasse alla cartella site, ma non posso perché come folder disponibili in gh-pages ho solo root e docs.

@Heryx
Copy link
Contributor Author

Heryx commented Sep 26, 2021

Salve a tutti,
ho clonato il repo che indicatomi da @gbvitrano. Nonostante tutto, riscontro sempre lo stesso problema, cioè che riesco ad accedere alla Home del sito, ma senza la possibilità di visualizzare il Template. Aggiungo un'immagine in basso come esempio.
In localhost funziona bene, quindi non capisco se è un problema dovuto alla config del file principale del sito, o se di GitHub.

Un saluto,
Giuseppe

image

@gbvitrano
Copy link
Member

Salve a tutti,
ho clonato il repo che indicatomi da @gbvitrano. Nonostante tutto, riscontro sempre lo stesso problema, cioè che riesco ad accedere alla Home del sito, ma senza la possibilità di visualizzare il Template. Aggiungo un'immagine in basso come esempio.
In localhost funziona bene, quindi non capisco se è un problema dovuto alla config del file principale del sito, o se di GitHub.

Un saluto,
Giuseppe

image

Buongiorno, hai clonato bene il repo? nel tuo manca la la cartella .github al suo interno c'è la cartella workflows che contiene il file gh-deploy.yml con le istruzioni per creare in automatico le gh-pages

image
2021-09-26_10h19_20

@gbvitrano
Copy link
Member

dopo devi settare l'indirizzo delle gh-pages
image

PS. se URL del sito non è quello canonico di github devi seguire questa guida per personalizzarlo.
il file CNAME con la sola riga del tuo URL deve stare all'interno della cartella doc visto che hai clonato il nostro repo, lo trovi già li, devi solo scrivere il tuo URL.
image

@Heryx
Copy link
Contributor Author

Heryx commented Sep 28, 2021

Ho clonato male il repository, ecco perché non funzionava.
In ogni caso, solo per esser certo di aver fatto bene: ho copiato il link del vostro repo e da repositories ho cliccato su news e successivamente import a repository, dove ho infine aggiunto il link del vostro repo.
Grazie mille per il supporto e la pazienza.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants