This is to publish Hyeokjin's "README" web pages in order to introduce himself on the Internet.
All the pages are generated by mkdocs-material.
Create an independent Python environment
$ python -m venv .venv
$ . .venv/bin/activate
(.venv) $ pip install --upgrade pip
This will automatically install compatible versions of all dependencies: MkDocs, Markdown, Pygments and Python Markdown Extensions. Material for MkDocs always strives to support the latest versions, so there's no need to install those packages separately.
(.venv) $ pip install mkdocs-material
To create a site, go to the directory where you want your project to be located and enter:
(.venv) $ mkdocs new .
.
├─ docs/
│ └─ index.md
└─ mkdocs.yml
(.venv) $ mkdocs serve
mkdocs-material - Write your documentation in Markdown and create a professional static site in minutes – searchable, customizable, for all devices. Dillinger - The last markdown editor Vercel - Vercel for GitLab
.
├── docs
│ ├── assets
│ │ ├── images
│ │ │ ├── ...png
│ │ │ ├── ...jpg
│ ├── index.md
│ └── stylesheets
│ └── extra.css
├── mkdocs.yml
└── README.md
.mdlrc: Configuration file of markdownlint .yamllint: Configuration file of yamllint README.md: The file you are reading right now