Code Documentation of the Future — MkDocs-Material Tutorial

Intro

The current documentation

Mkdocs — Material Theme

  1. Awesome layout
  2. Mobile friendly
  3. Amazing text search

Screw it lets do it

Install

pip install mkdocs mkdocs-material
site_name: name-of-your-site
theme:
name: 'material'
# Getting Started

Full code on [github](https://github.com/ahmednafies/sanic_camelcase_middleware).

## Install
pip install sanic_camelcase_middelware

## Dependencies
* [pyhumps](https://pypi.org/project/pyhumps/)
* [sanic](https://pypi.org/project/sanic/)

## Example
from sanic import Sanic
from sanic_camelcase_middleware import Camelize

app = Sanic(__name__)
Camelize(app)

lets add more pages

# Install## pip
pip install sanic_camelcase_middelware
## pipenv
pip install sanic_camelcase_middelware
# Full example
from sanic import Sanic
from sanic.response import json
from sanic_camelcase_middleware import Camelize

app = Sanic(__name__)

Camelize(app)


@app.route("/post", methods=["POST"])
async def test(request):
return json("is_camelcase": True, "message": request.json})


if __name__ == "__main__":
app.run(host="0.0.0.0", port=8000)
site_name: name-of-your-sitenav:
- Getting Started: index.md
- Install: install.md
- Full Example: example.md
theme:
name: 'material'
$ mkdocs serve
site_name: name-of-your-sitenav:
- Getting Started: index.md
- Install: install.md
- Full Example: example.md
theme:
name: 'material'
palette:
primary: 'green'

Deploy to github pages

$ mkdocs gh-deploy

--

--

--

Software Developer

Love podcasts or audiobooks? Learn on the go with our new app.

Recommended from Medium

Deep Dive | StarTerra

Mastering auto speech adaptation in Dialogflow for voice agents

Controlling Procrastination and Get Your AWS Solution Architect Professional Certificate

The wicked problem of scalability in Cloud computing and How to defeat?

Git Basics Simply Explained For Beginners

CHALLENGES IN AGILE PROJECT MANAGEMENT METHODOLOGY

Handle Fi Testnet

The NLP Cypher | 10.17.21

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Ahmed Nafies

Ahmed Nafies

Software Developer

More from Medium

Getting started with Django Web Framework and Docker

How to build a JSON formatted resume API with Django, and ElephantSQL

Exploring Full-Text Search with Django/PostgreSQL

What is a web API… and how can I create one with Python?