Documentation
-
All the documentations are written in Mark Down files in docs directory
-
We use Material MkDocs to generate the website
How to edit the docs?
- Clone the repository
git clone https://github.com/amrdeveloper/easyadapter.git
- Enter the docs directory
cd docs
- Edit the file, you can see the output live on the website using mkdocs serve,
mkdocs serve
- Open docs website locally to see the output.
http://127.0.0.1:8000/easyadapter
- After finishing the modification, commit and make Pull request.