MumPy Website

Theme taken from mkdocs-simple-blog

Install

Installation MkDocs

To install MkDocs, run the following command from the command line:

pip install mkdocs

Installation theme

Install the theme using PIP:

pip install mkdocs-simple-blog

Preview/ Run Locally

mkdocs serve

Build and deploy to gh pages

1. commit and push all the changes to main branch

git add . && git commit -m "your commit message"
git push origin main

2. Checkout/switch to the gh-pages branch and rebase with the latest changes of the main branch

git switch gh-pages && git rebase origin/main

3. Build your MkDocs site using mkdocs build command

4. Navigate to the /site directory in your local repository and create a temporary git repository:

cd site
git init

5. Commit the Changes & push to gh-pages branch:

git add . && git commit -m "Deploy MkDocs Site"
git push -f https://github.com/mumbaipy/website.git master:gh-pages

6. Clean up:

Once you've successfully pushed to gh-pages, you can delete the temporary Git repository in the /site directory:

rm -rf .git

Need Help?

Read the MkDocs Documentation :)

License

This project is licensed under the terms of the MIT license.