Wednesday, 22 October 2014

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)
REM Automate the build process of creating a website from mkdocs markdown

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
This can run on a schedule or even could be set up to run when something changes in the document source location.


10 comments:

Robert F. Crocker said...

I really love your write-ups guys continue the good work psd to drupal

Richard C. Lambert said...

AngularJS supports .wrap() jQuery functionality. Here in below examples we can see how to wrap HTML structure around an element.psd to css

Html Pro said...

HTML Pro Team has got an extensive expertise in Design/AI/PSD to Drupal Theme Conversion. HTML Pro is a trusted name among all Drupal development service providers, with a team of 50+ in-house developers; we’re passionate to provide you the most reliable Drupal development services. Our Drupal code meets all the web standards as we deliver W3C valid, SEO semantic, pixel perfect and handwritten markup.

Deepika Analy said...

Thanks for making me this article. You have done a great job by sharing this content in here. Keep writing article like this.

Angular Training in Chennaihennai
Angular JS Training in Chennai

Joe said...


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 Fiber said...

You managed to hit the nail upon the top and also defined out the whole thing without having side effect , people could take a signal. Will likely be back to get more. Thanks
Tangki Panel
Tangki Fiberglass
Jual Septic Tank

Kayal m said...

This post very useful for enhancing my knowledge. I got huge information in this post. Thank you!!!
Tableau Training in Chennai
Tableau Course in Chennai
Spark Training in Chennai
Pega Training in Chennai
Excel Training in Chennai
Oracle Training in Chennai
Oracle DBA Training in Chennai
Social Media Marketing Courses in Chennai
Tableau Training in Chennai
Tableau Course in Chennai

Sivanandhana Girish said...

Well written Blog, I really enjoy reading your blog. this info will be helpful for me. Thanks for sharing.
ccna Training in Chennai
ccna institute in Chennai
Angularjs Training in Chennai
PHP Training in Chennai
Web Designing Course in Chennai
ccna course in chennai
ccna training in chennai

Anbarasan14 said...

This was an well written blog and I am happy reading your blog.

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

Sivanandhana Girish said...

I believe that your blog gave valuable information to the readers. kindly keep sharing this kind of useful information.

English Speaking Classes in Mulund
English Speaking Classes in Mulund West
English Speaking Course in Mulund
English Speaking Course in Mulund East
English Speaking Course in Mulund West
Best English Speaking Classes in Mulund West
English Speaking Classes Mulund