Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

MichaelJJ/docs

Open more actions menu
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

296 Commits
296 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation for development of mkdocs-material documentation site

Local Development (docker) (recommended):

docker-compose -f "docker-compose.yml" up -d --build

Local Development (native)

In order to render and preview the site locally (without docker) you will need a few things to get started.

  1. You will need to install python and pip

  2. After python is installed, you'll need the following python dependencies: pip install mkdocs pip install mkdocs-material==7.2.2 pip install mkdocs-render-swagger-plugin

  3. Once you have all the pre-reqs installed. You can simply run mkdocs serve and view the rendered content locally and makes changes to your documentation and preview them in realtime with a browser open.

About

This repository holds the source content for the documentation rendered on github.io

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Dockerfile 56.4%
  • HTML 43.6%
Morty Proxy This is a proxified and sanitized view of the page, visit original site.