https://github.com/giswqs/mkdocs-template

A template for building a mkdocs website
https://github.com/giswqs/mkdocs-template

geemap geospatial leafmap mkdocs mkdocs-material

Last synced: about 2 months ago
JSON representation

A template for building a mkdocs website

• Host: GitHub
• URL: https://github.com/giswqs/mkdocs-template
• Owner: giswqs
• License: mit
• Created: 2022-03-11T16:27:42.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-12-14T06:54:07.000Z (about 1 year ago)
• Last Synced: 2024-11-02T12:33:51.416Z (about 2 months ago)
• Topics: geemap, geospatial, leafmap, mkdocs, mkdocs-material
• Homepage: https://giswqs.github.io/mkdocs-template/
• Size: 677 KB
• Stars: 14
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mkdocs-template

A template for turning Jupyter notebooks and markdown files into a website.

Steps to use this template:

- Click the **Use this template** green button on this GitHub repo and fill in the details to create a repo under your account.

- Clone the newly created repo to your computer and open it using a Text Editor (e.g., Visual Studio Code).

- Use the Text Editor to search `mkdocs-template` and replace it with your repo name.

- Add/remove dependencies in `requirements.txt` if need.

- Add folders (e.g., `chapter_01`) and files (e.g., `intro.ipynb`, `index.md`) to the `docs` folder.

- Open `mkdocs.yml` and make several changes, including `site_name`, `site_url`, `repo_url`, and `nav`. If you don't want the notebooks to be executed when building the website, set `execute: False` under `plugins`.

- Customize the issue template (`.github/ISSUE_TEMPLATE/config.yml`) if needed. 

- Commit the changes using Git and push changes to GitHub.

- Enable GitHub Pages through GitHub Settings - Pages. 

- Check out the website at https://username.github.io/repo-name.