drifty/materialmkdocs
1
0
Fork 0
mirror of https://github.com/driftywinds/materialmkdocs.git synced 2025-12-19 13:03:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
drifty
2025-01-22 16:35:00 +05:30
parent e286120eb6
commit 6bb996a76f
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -1,3 +1,9 @@
### My Docs! ## My Docs!
This repo will exactly reproduce my docs site using Material for MkDocs with every new commit. This repo will exactly reproduce my docs site using Material for MkDocs with every new commit.
This is also my way of figuring out how to do documentation for my stuff for the longterm in an aesthetic way. This is also my way of figuring out how to do documentation for my stuff for the longterm in an aesthetic way.
### What are the .ps1 and .exe files?
The exe is a build of the .ps1 script file that automates serving, and building & pushing of the site to your respective places. THINGS TO KEEP IN MIND BEFORE USING: -
- mkdocs needs to be installed and your site needs to be initialized properly already
- git needs to be installed and initialized with your repo, so that the script can commit and push to it. The format of commit names is ```([datetime]('yyyy-MM-dd HH:mm:ss'))```