Skip to main content

simple theme github for Mkdocs

Project description

Mkdocs-Github Theme for MkDocs


Simple Theme for Mkdocs.


Required: Python 3.4+

If you haven't installed MkDocs yet, use the following command to install it:

$ pip install mkdocs

Next, navigate to a clean directory and create a new MkDocs project with the following command:

$ mkdocs new [projectname]

Replace [projectname] with the name of your project (without the brackets).

Then navigate to the root of your project directory:

$ cd [projectname]

Install Github Theme

with PIP pip install mkdocs-github or download with zip.


mkdocs.yml for install via zip

site_name: yourdocs
site_author: you
site_description: "you word."
site_keyword: "you word"

  name: null
  custom_dir: github
  highlightjs: true
  hljs_style: github

 github_repo: mkdocs-Github 
 github_user: g3xx

mkdocs.yml with install via PIP

site_name: yourdocs
site_author: you
site_description: "you word"
site_keyword: "your tag"

  name: github
  highlightjs: true
  hljs_style: github

 github_repo: antiFramework 
 github_user: g3xx


MIT and CSS by sindresorhus

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs-github, version 0.0.6
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs_github-0.0.6-py3-none-any.whl (13.9 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page