Question about Building Nvda Documentation Files

12 views
Skip to first unread message

Marcos Antonio Schllosser

unread,
Dec 27, 2025, 2:54:24 PM (13 days ago) 12/27/25
to nvda-...@nvaccess.org
Greetings.

I downloaded the latest Nvda Alpha and checked in the documentation
folder that in the folders for each language there is an HTML file and
an md file about the User Guide, Nvda News and the Commands Quick Reference

But when consulting the .md files, I found that they are not updated
with the information on the most current versions of Nvda.

Therefore, I would like to ask some questions so that I can obtain this
information:

1. How can I download the most current Nvda documentation files in
Markdown .md. I would like to obtain these files because I want to study
how to write in Markdown.

2. After writing a Markdown .md file using Notepad++, how can I
transform this Markdown file into an HTML file to read in browsers, as
can I do with Nvda documentation files that are in HTML?

If you could tell me how the developers go about writing and creating
these files, I would be very grateful. Because I want to learn how to
produce accessible documents in Markdown to transform them into HTML.

joseph....@gmail.com

unread,
Dec 27, 2025, 3:11:38 PM (13 days ago) 12/27/25
to nvda-...@nvaccess.org
Hi,
Let's discuss this on the NVDA development list because doing this task requires the full NVDA source code plus Python and its tools plus development tools such as Visual Studio Build Tools. But in short, you would turn Markdown files into HTML via Markdown Python package (found in Python Package Index (PyPI)).
Cheers,
Joseph
--
***
Please note: the NVDA project has a Citizen and Contributor Code of Conduct.
NV Access expects that all community members will read and abide by the rules set out in this document while participating in this group.
https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md

You can contact the group owners and moderators via nvda-user...@nvaccess.org.
---
You received this message because you are subscribed to the Google Groups "NVDA Screen Reader Discussion" group.
To unsubscribe from this group and stop receiving emails from it, send an email to nvda-users+...@nvaccess.org.
To view this discussion visit https://groups.google.com/a/nvaccess.org/d/msgid/nvda-users/453c9755-a6cc-4a3e-bef4-cc36d1529968%40gmail.com.

Sean Budd

unread,
Dec 28, 2025, 7:10:31 PM (12 days ago) 12/28/25
to NVDA Screen Reader Discussion, Informática Dv
Greetings!

You can find the latest markdown versions of our user docs in our git repository: https://github.com/nvaccess/nvda/tree/master/user_docs.
However, this might not be helpful, as we use our own custom syntax.
There are many different "flavours" of writing markdown, depending on the tools you are using.
We use a custom version with custom tooling.
If you are not looking to contribute to NVDA, but rather create your own markdown files, I would focus on that and not involve or think about NVDA markdown at all.
Instead, I would suggest using a browser based markdown editor such as stackedit or markdown2html to learn and create markdown files.

Since this is off-topic to NVDA, I am locking this thread, but feel free to email me directly if you have further questions and I'll try to respond on my own time outside work hours.

Cheers,
Sean
NV Access
Reply all
Reply to author
Forward
This conversation is locked
You cannot reply and perform actions on locked conversations.
0 new messages