File tree Expand file tree Collapse file tree 1 file changed +45
-0
lines changed Expand file tree Collapse file tree 1 file changed +45
-0
lines changed Original file line number Diff line number Diff line change @@ -197,6 +197,51 @@ select PROJECT.DATASET.faker("name", "it_IT")
197197<br >
198198
199199
200+ ### 7. Host your Documentation on GitHub Pages
201+
202+ > ** 💡 Note:**
203+ > If you want to host your documentation on GitLab, please check [ this link] ( #https://gitlab.com/pages/mkdocs ) .
204+
205+ #### Steps to Host Your Documentation on GitHub Pages
206+
207+ 1 . ** Create a new repository** on GitHub.
208+ 2 . ** Initialize Git** in your local project:
209+ ``` sh
210+ git init
211+ ```
212+ 3 . Add the remote repository
213+ ``` sh
214+ git remote add origin < repository-url>
215+ ```
216+ 4 . Generate the documentation
217+ ``` sh
218+ bigfun docs generate
219+ ```
220+ 5 . (Optional) Preview the documentation before publishing
221+ ``` sh
222+ bigfun docs serve
223+ ```
224+ Then open http://localhost:8000 in your browser.
225+
226+ 6 . Add, commit, and push your changes
227+ ``` sh
228+ git add .
229+ git commit -m " Add documentation"
230+ git push origin main
231+ ```
232+ 7 . Deploy to GitHub Pages
233+ ``` sh
234+ mkdocs gh-deploy --force
235+ ```
236+ 8 . Access your hosted documentation
237+ ``` sh
238+ https://< your-github-username> .github.io/< repository-name> /
239+ ```
240+
241+
242+ <br >
243+
244+
200245## ❓ FAQ
201246
202247<details >
You can’t perform that action at this time.
0 commit comments