Skip to content

skedgo/skedgo-mkdocs-theme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

57 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

SkedGo custome theme for MKDocs

A custom MkDocs theme built for SkedGo documentation sites.

๐Ÿš€ Getting Started

  1. Go to your MkDocs project directory
  2. Install the theme from GitHub: pip install git+https://github.com/skedgo/skedgo-mkdocs-theme
  3. In your mkdocs.yml file, update the theme section:
theme:
  name: skedgo
  1. Then run your MKDocs project locally to see the new is applied

๐Ÿ“ Develop theme

  1. Go to skedgo_mkdocs_theme folder: cd skedgo_mkdocs_theme
  2. Run npm install
  3. Run npm run dev

๐Ÿงฐ Build theme

  1. Increase version number in file setup.py
  2. Increase theme_version number in file mkdocs_theme.yml
  3. Run npm run build

About

Custom MKDocs theme for SkedGo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •