PlanetSquires Forums

Please login or register.

Login with username, password and session length
Advanced search  

Author Topic: Markdown (*.md) files and Help *.chm files  (Read 249 times)

Paul Squires

  • Administrator
  • Master Member
  • *****
  • Posts: 8635
  • Windows 10
    • PlanetSquires Software
Markdown (*.md) files and Help *.chm files
« on: August 18, 2018, 01:43:26 PM »

Hi Jose,

I love the idea of using markdown and GitHub docs for your doumentation
https://blog.github.com/2016-08-22-publish-your-project-documentation-with-github-pages/

I started ot use markdown as well for WinFormsX but found that the PDF generation of the tool I was using didn't handle line breaks very well. It looked great until I outputted it to pdf. A good offline reader for markdown files would be great so that we can dispense with CHM files (or use a tool that can convert the md to chm like https://github.com/Phrogz/docubot).

A simple viewer would be cool rather than a full-blown editor so I could call the viewer via WinFBE's Help menu or a User Tool.

If anyone finds such a tool that would integrate well into WinFBE as a help file reader for markdown files then please share your experience.

Logged
Paul Squires
PlanetSquires Software
FireFly Visual Designer, WinFBE Editor

Josť Roca

  • Moderator
  • Master Member
  • *****
  • Posts: 3109
    • Jos
Re: Markdown (*.md) files and Help *.chm files
« Reply #1 on: August 18, 2018, 04:42:58 PM »

What I like is that I can do immediate changes and keep the documentation always updated. My help file has become so big that it is a pain to update it with HelNDoc. When I have to create new entries or generate new html and chm files it takes a looooong time. Help and Manual is very good, but also very expensive.

A way to generate .pdf files on line is to use in your browser the address of your .md page changing github to gitprint, i.e.

https://gitprint.com/JoseRoca/WinFBX/blob/master/docs/File%20Management/CFileStream%20Class.md

for

https://github.com/JoseRoca/WinFBX/blob/master/docs/File%20Management/CFileStream%20Class.md
« Last Edit: August 18, 2018, 04:47:24 PM by Josť Roca »
Logged