How is AHK Documentation created?

Discuss Autohotkey related topics here. Not a place to share code.
Forum rules
Discuss Autohotkey related topics here. Not a place to share code.
User avatar
deluxeAHK
Posts: 2
Joined: 13 Apr 2021, 07:34

How is AHK Documentation created?

Post by deluxeAHK » 13 Apr 2021, 07:47

Hi AHK Community,
does anyone know how AHK Documentation is created? I found the HTML files that are in the git repo, but no mention of any tool that creates the files. Are they created manually???

Link to repo:
https://github.com/Lexikos/AutoHotkey_L-Docs

I hope someone can help me out.

Greetings Sam
gregster
Posts: 6095
Joined: 30 Sep 2013, 06:48

Re: How is AHK Documentation created?

Post by gregster » 13 Apr 2021, 07:52

I think, Ragnar is mainly keeping the docs frontend up-to-date (and doing a lot more) - his answer to a similar question in last december:
Ragnar wrote:
31 Dec 2020, 05:19
No documentation software was used. Everything is created on our own. All you need is free time, a decent text editor and knowledge about HTML and JavaScript ;)
(topic: https://www.autohotkey.com/boards/viewtopic.php?p=373540#p373540)
User avatar
deluxeAHK
Posts: 2
Joined: 13 Apr 2021, 07:34

Re: How is AHK Documentation created?

Post by deluxeAHK » 13 Apr 2021, 08:07

Hi Gregster,
thanks for the quick reply. Not the answer I was hoping to get, but thanks anyway.

Greetings Sam
User avatar
jasc2v8
Posts: 53
Joined: 10 Dec 2020, 12:24
GitHub: jasc2v8

Re: How is AHK Documentation created?

Post by jasc2v8 » 13 Apr 2021, 09:58

I replicate a simplified version of the AHK doc style using pandoc to convert a markdown document to html.

1. Download the files at https://github.com/jasc2v8/AHKEZ/tree/main/AHKScripts/MakeDoc
2. Download and install https://pandoc.org/releases.html
3. Edit pandoc.cmd to point to your pandoc.exe and index.html folders
4. Rename index.html to index_old.html
5. Run pandoc.cmd
6. The file index.html will be created and will open in your windows default browser.
7. Edit the index.md markdown document to change the content then repeat the above to convert to html

Hope this helps.
Post Reply

Return to “General Discussion”