mkdocs-template

This repository is my template for the use of mkdocs.

When you do a git push against the remote repository, the GitHub Pages will be updated.

Usage

Using this repository as a template, create a new repository.

Edit mkdocs.yml

site_name: {Arbitrary name}
.
.
theme:
  name: material
  language: "{Your local language}"
.
plugins:
  search:
    lang: "{Your local language}"

Add markdown files to docs. Then change nav in medocs.yml.

Then you can git push and go to the https://{github id}.github.io/{repository name}/

example -> https://shunsuke6.github.io/mkdocs-template/

locally

If you want to run it locally.

Depend on

• asdf
• python
  • mkdocs
• nodejs
  • markdownlint
  • markdownlint-cli

If your editor is VSCode, Sublime or ccc-Vim(NeoVim) and you are using markdown lint, you can remove the following.

.tool-versions> nodejs 19.0.1

rm -f package-lock.json package.json

Your remote repository settings. action>general > Workflow poermission >

• [x] Read and write poermission

Save.

Usage

1. Add asdf plugins.

asdf plugin-add python
asdf plugin-add nodejs
# If need to nodejs

1. Install asdf plugins.

asdf install

1. Install mkdocs using pip.

pip install --requirement requirements.txt

1. If you need to markdown lint

npm install

1. Local boot with mkdocs.

mkdocs serve

Accessed at http://127.0.0.1:8000/

1. For manual deployment, run the command

mkdos gh-deploy