https://github.com/g3xx/mkdocs-github

Theme Mkdocs Like a Github. DEMO =>
https://github.com/g3xx/mkdocs-github

github-theme mkdocs mkdocs-theme theme

Last synced: 14 days ago
JSON representation

Theme Mkdocs Like a Github. DEMO =>

• Host: GitHub
• URL: https://github.com/g3xx/mkdocs-github
• Owner: g3xx
• License: mit
• Created: 2020-02-25T04:04:58.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-25T09:13:04.000Z (almost 5 years ago)
• Last Synced: 2024-12-24T22:10:15.167Z (14 days ago)
• Topics: github-theme, mkdocs, mkdocs-theme, theme
• Language: CSS
• Homepage: https://github.g3xx.com/
• Size: 59.6 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mkdocs-Github Theme for MkDocs

## About

Simple Theme for Mkdocs.

## Install

**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.

## Configuration

**mkdocs.yml** for install via **zip**

```yml

site_name: yourdocs

site_author: you

site_description: "you word."

site_keyword: "you word"

theme:

  name: null

  custom_dir: github

  highlightjs: true

  hljs_style: github

 

badge:

 github_repo: mkdocs-Github 

 github_user: g3xx

```

**mkdocs.yml** with install via **PIP**

```yml

site_name: yourdocs

site_author: you

site_description: "you word"

site_keyword: "your tag"

theme:

  name: github

  highlightjs: true

  hljs_style: github

 

badge:

 github_repo: antiFramework 

 github_user: g3xx

```

## License

**MIT** and CSS by [sindresorhus](https://github.com/sindresorhus/github-markdown-css)