darkthanblack / darkthanblack.github.io

darkThanBlack.github.io

My practice is?

• branchs
  • main: newest README.md + all .md sources in ./docs/ + mkdocs.yml
  • gh-pages: all webside sources, generate by MKDocs CI
  • pictures: image hosts, generate by PicGo CI
• ignore
  • ./site/

What tool did I use?

Versions

Name	Version
Python	3.8.2
Markdown	3.3.6
mkdocs	1.2.3
mkdocs-material	8.1.8
mkdocs-material-extensions	1.0.3
pymdown-extensions	9.1
PicGo	2.3.1-beta.2

MKDocs

# python env
brew install [email protected]

# use venv
python3.12 -m venv ~/venv3.12
source ~/venv3.12/bin/activate

# install plugins
python3.12 -m pip install mkdocs-material
python3.12 -m pip install mkdocs_pymdownx_material_extras

# exit venv
deactivate

# create
$ mkdocs new my-project

# Local host: http://127.0.0.1:8000/
$ mkdocs serve

# File path: ./site/
$ mkdocs build

# Github CI branch: gl-pages
$ mkdocs gh-deploy

• Doc: Theme-Material

  # install
  $ pip install mkdocs-material
  
  # third part plugins
  $ pip install mkdocs_pymdownx_material_extras

• Doc: Keywords

Image hosts

• Current: Github
  • CI branch: pictures
  • CI Tool: PicGo
    • issue 781
  • image path: ./docs/assets/pictures/

Sina weibo

https://tva1.sinaimg.cn/large/008i3skNly1gy8f3g2v9fj301s01sdfm.jpg

Github

https://raw.githubusercontent.com/darkThanBlack/darkThanBlack.github.io/pictures/docs/assets/pictures/logo_64.png