![]() INFO - Documentation built in 0.57 seconds pymdownx.tilde Step 1: Preview your documentation locally python3 -m mkdocs serve Repo_url: /Įdit_uri: edit/master/Įmoji_index: !!python/name:Įmoji_generator: !!python/name:_svgįormat: !!python/name:_code_format Here is an example configuration for the mkdocs.yml file and here you find an example project, which is based on that configuration. MkDocs installation on Mac Step 1: Verify the brew installation brew -version Step 2: Change the folder permission to install python, if needed sudo chown -R $(whoami) /usr/local/lib/pkgconfigĬhmod u+w /usr/local/lib/pkgconfig Step 3: Install python3 brew install python3 Step 4: Upgrade pip pip3 install -upgrade pip Step 5: Install mkdocs pip3 install mkdocs Step 6: Install mkdocs-material pip3 install mkdocs-material Step 7: Install mkdocs-material-extensions pip3 install mkdocs-material-extensions Verify and build your documentation Step 1: Ensure you have the mkdocs.yml file in place The gif shows the example project documentation: Local setup on Mac OS Here an example GitHub project, which is based on the setup I documented in this blog post: Steve Martinelli created an awesome blog post in that context called 5 Features I Like About Material for MkDoc. ![]() The blog post is for me a little cheat sheet and maybe it is also useful for you. I won’t covering details about the background. ![]() This blog post contains the simplified steps, how to setup MkDocs for a GitHub project to use it with GitHub Pages. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |