New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
distribute ".txt" files without markup #159
Comments
The actual package ships with the HTML pages. Unclear what removing the markdown would achieve other than the necessity to maintain 2 documentation sources. |
The marked-up documents are difficult to read via the command-line, particularly 5_TechReference.txt. The goal is to eliminate the current barrier to building CaPTk when working from the command-line. There is no need to maintain multiple documentation sources. Think of the marked-up documentation as source code. The distributed package should contain a processed version of that documentation, as a plain-ASCII file without markup. This can be done easily from an HTML source (ie., 'lynx -dump', 'elinks -dump', etc). |
I would assume something like this would solve our issues? |
Another solution: https://www.npmjs.com/package/doxygen2md |
Another project based on doxygen2md: https://devhub.io/repos/sourcey-moxygen |
@surrsurus : could you take a look at the latter project to see if the conversion is straightforward? I was not able to install it on my Windows machine. The usage is pretty simple: just direct the input as |
This reverts commit edb86d9.
The various text file contain markup directives, making them very difficult to read. For example, 5_TechReference.txt has the following instructions for building CaPTk:
The files should be renamed, and plain-ASCII-text versions created (named with the '.txt' extension).
The text was updated successfully, but these errors were encountered: