Skip to content
Simple RTL boilerplate for mkdocs and material theme
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
README.md
mkdocs.yml

README.md

doc-boilerplate

برای ساخت مستندات میتوانیم از این ابزار استفاده کنیم. زیبا و راحت و سریع و قابل تغییر!

installation (for linux users)

sudo apt install python3-pip

python3 -m pip install mkdocs-material --user

for zsh users:

echo export PATH=$HOME/.local/bin:$PATH >> $HOME/.zshrc

source $HOME/.zshrc

for bash users:

echo export PATH=$HOME/.local/bin:$PATH >> $HOME/.bashrc

source $HOME/.bashrc

Sample Project

git clone https://github.com/amirbagh75/rtl-mkdocs.git

cd rtl-mkdocs

mkdocs serve

open your browser and go to: http://127.0.0.1:8000

Usage

For run:

mkdocs server

For Build Statis HTML/CSS/JS:

mkdocs build

More Info

https://www.mkdocs.org/

https://squidfunk.github.io/mkdocs-material/

https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

You can’t perform that action at this time.