Skip to content

rohitfarmer/mk-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

87 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentations by Rohit Farmer

This repository contains both markdown files in the content directory to be compiled by MK Docs and the rendered website in the docs directory to be served by GitHub Pages.

MkDocs: https://www.mkdocs.org/
Theme used: Material for MkDocs

To Build the Site Locally

To render the website using mkdocs, execute the build-site.sh shell script. It first runs mkdocs to build the website in the docs directory and then copies .nojekyll file to the docs folder.

bash build-site.sh

To Serve the Site Locally

cd docs
mkdocs serve

Changelog

2025-12-11: The website nomore was built and served by Netlify. This was the tutorial to set up an automatic build and serve by Netlify https://www.starfallprojects.co.uk/projects/deploy-host-docs/deploy-mkdocs-material-netlify/ in the past.

The last commit with the previous structure: 26c9652542f19aac11a5c7202a5ec6d857eba187

About

Documentations by Rohit Farmer

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages