You can download the latest release from Github. One-File Docs takes one or several markdown files and generates a single HTML file. The goal is to have a tool that is as lightweight as possible with as few dependencies as possible. All you should have to do is download the executable and use it right away without having to install anything. One-File docs is also accessible as a single-file C library that should be very easy to integrate with your codebase and work with all major C/C++ compilers. The goal here is simplicity. If you only want a single HTML file containing documentation without having to deal with multiple files and folder hierarchies, then this tool is for you. If you are also looking for a tool that just works on its own without having to download packages or whatnot, you knocked on the right door. Basic usage: Specifying a folder instead: . Learn more about building documentation from folders. A configuration file is a simple text file that contains fields. You can specify one line per field. Example: Right now there are 3 types of fields:

• Colour fields
• Real number fields
• String fields

A colour is composed of 4 real numbers representing red, green, blue and alpha. All values must be in [0;1]. Example: The way you specify a real number is straightforward: Strings are enclosed in quotes. Note that for now you cannot escape characters in a string. Example: A theme is a configuration file where you can specify the following fields: A project configuration file is a configuration file where you can specify the following fields: When you build documentation from a folder all files within the folder are used as input. Note that sub-folders are taken into account. If you like to work with project configuration files you can also add one in the folder, just make sure you name it and it will automatically be used. You can easily override values from the file by providing them on the command line. For example if you want to output documentation to a different file you can run . When you specify markdown files on the command-line they are added in order to the HTML file. Since here we are loading them from a folder, the order would depend on the OS. To mitigate this, simply prepend a number to the file name, e.g. . One-File Docs will then sort files in ascending order according to this number. This number will appear in the final documentation. One-File Docs supports most Markdown features and has a few of its own. Some features are currently not available but will likely be added in the future. You can use to escape a character. This also works on new line characters. You can use the usual syntax for links: You can use markdown for the link text. The usual image syntax is supported with additional options: You can use markdown in the image title. The character represents a table cell. If there is an empty line between two rows then you get two different tables. Example: You can use markdown within table cells. You can easily embed HTML using . Example: This produces the following: The usual ` syntax can be used for code blocks. One-File Docs also supports code blocks with syntax highlighting using the following syntax: List of supported language IDs: You can display a todo-list in the following way: The code above gives the following result:

• Item 1
• Item 2
• Item 3
• Item 4
• Item 5

You cannot specify a header in the following way: This feature is very unlikely to be added in the future. If enough people show interest in this it will be added in the future but right now this is not supported and there are no plans to support it. We currently provide binaries for Windows (x64), Linux (x64) and macOS (x64, ARM). We also provide shell scripts for building the program with major compilers. If you want to build it yourself without using one of the provided options, all you have to do is give to your compiler of choice. Make sure you also link against the C runtime. On Windows make sure to link against . You can use One-File Docs as a C/C++ library by including in your project. All you have to do is to make sure you define in your codebase before including . For additional information check . Check if you want to see it in action. One-File Docs is placed under the MIT license. Copyright (c) 2023 Delicious Lines Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. If you want to report a bug or request a feature head to the Github repository and open an issue.

• Tables are now horizontally scrollable when they do not fit on the page.
• BREAKING CHANGE: to specify file order when building from a directory just prepend a number to the file name.
• Unordered lists are now properly handled and you can nest them.
• You can now use ordered lists and you can nest them.
• Todo-lists are now available.