Automate mkdocs html files build process
At work I needed to find a way of writing a lot of documentation easily and quickly. The system was going to be used by technical and non-technical people.
For this I am current looking at a great project called mkdocs. This is a python program that allows for all documentation to be created in markdown syntax and then built into a flat html website.
Markdown is a text to html processor that has an easy to learn syntax . Markdown files can be created in any text editor. So users can be focused on creating documentation rather than getting distracted.
My idea was to allow all user to create documentation and see the changes instantly on the website. mkdocs has a setting that dynamically shows how your pages will look in a browser while creating the documentation source files.
This works great but I needed to be able to build flat html files and copy them to a web server.
Below is the batch file (windows)
For this I am current looking at a great project called mkdocs. This is a python program that allows for all documentation to be created in markdown syntax and then built into a flat html website.
Markdown is a text to html processor that has an easy to learn syntax . Markdown files can be created in any text editor. So users can be focused on creating documentation rather than getting distracted.
My idea was to allow all user to create documentation and see the changes instantly on the website. mkdocs has a setting that dynamically shows how your pages will look in a browser while creating the documentation source files.
This works great but I needed to be able to build flat html files and copy them to a web server.
Below is the batch file (windows)
REM Automate the build process of creating a website from mkdocs markdownThis can run on a schedule or even could be set up to run when something changes in the document source location.
REM Change to source drive
X:
REM path to docs site to convert
cd X:\DocSource\admin
REM covert to flat html website (this creates a 'site' folder)
c:\Python27\python.exe c:\Python27\Scripts\mkdocs build
REM copy site to web server folder
xcopy site\* c:\inetpub\wwwroot\admin\* /s /e /y
Comments
Thanks for sharing this wonderful article. Your article is very interesting to read. Looking forward to read ur future post.
Node JS Training in Chennai
Node JS Course in Chennai
Tangki Panel
Tangki Fiberglass
Jual Septic Tank
Spoken English Class in Thiruvanmiyur
Spoken English Classes in Adyar
Spoken English Classes in T-Nagar
Spoken English Classes in Vadapalani
Spoken English Classes in Porur
Spoken English Classes in Anna Nagar
Spoken English Classes in Chennai Anna Nagar
Spoken English Classes in Perambur
Spoken English Classes in Anna Nagar West
Data Science Course in Chennai
Data Science Courses in Bangalore
Data Science Training in BTM
Data Science Training in Marathahalli
Data Science Course in Marathahalli
Best Data Science Training in Marathahalli
Data Science Institute in Marathahalli
PHP Training in Bangalore
DOT NET Training in Bangalore
Spoken English Classes in Bangalore
Cyber Security Training Course in Chennai | Certification | Cyber Security Online Training Course| Ethical Hacking Training Course in Chennai | Certification | Ethical Hacking Online Training Course| CCNA Training Course in Chennai | Certification | CCNA Online Training Course| RPA Robotic Process Automation Training Course in Chennai | Certification | RPA Training Course Chennai| SEO Training in Chennai | Certification | SEO Online Training Course
Oracle Training in Chennai
Oracle Training in Bangalore
Oracle Training in Coimbatore
Tableau Training in Chennai
Tableau Training in Bangalore
Java Training in Bangalore
Java Classes in Pune
Java Training in Hyderabad
Java Training in Delhi
Java Training in Gurgaon
Tally Course in Chennai
Tally Training in Chennai
DOT NET Training in Chennai
DOT NET Course in Chennai
Visit: Best Langger Gun Safes in US.
RPA Training in Bangalore
RPA course in Bangalore
RPA Training in Chennai
RPA Training Institute in Bangalore
Robotic Process Automation Training in Chennai
RPA Classes in Chennai
Visit: Best Washing Machine under Rs 10000
Visit: Best Mixer Grinder in India.
Visit: SEO Specialist India
Visit: best bajaj induction cooktop in india
Really nice blog. thanks for sharing
best selenium training in chennai
Best selenium Training Institute in Chennai
Data Science Requirements
Career In Data Science
hadoop training in velachery
Big data training in chennai
Angularjs training in anna nagar
Angularjs Training in Chennai