Skip to content

Commit

Permalink
Update mkdocs_pages.qmd
Browse files Browse the repository at this point in the history
  • Loading branch information
albarema authored May 28, 2024
1 parent b0dda41 commit f20ac7d
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion develop/examples/mkdocs_pages.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@ summary: Build git pages using mkdocs
---
# Build your GitHub Page using Mkdocs

Install MkDocs and MkDocs extensions using the command line. Additional extensions are optional but can be useful if you choose this approach.

```{.bash}
pip install mkdocs # create webpages
pip install mkdocs-material # customize webpages
pip install mkdocs-video # add videos or embed videos from other sources
pip install mkdocs-minify-plugin # Minimize html code
pip install mkdocs-git-revision-date-localized-plugin # display last updated date
pip install mkdocs-jupyter # include Jupyter notebooks
pip install mkdocs-bibtex # add references in your text (`.bib`)
pip install neoteroi-mkdocs # create author cards
pip install mkdocs-table-reader-plugin # embed tabular format files (`.tsv`)
```

:::{.callout-exercise}

# Exercise 5: make a project folder and publish a data analysis webpage
Expand Down Expand Up @@ -42,4 +56,4 @@ summary: Build git pages using mkdocs
After a couple of minutes, your webpage should be ready! You should be able to see your webpage through the link provided in the Page section!

Now it is also possible to include this repository webpage in your main webpage `<organization>`.*github.io by including the link of the repo website (https://`<organization>`.*github.io/*repo-name*) in the navigation section of the `mkdocs.yml` file in the main *organization*github.io repo.
:::
:::

0 comments on commit f20ac7d

Please sign in to comment.