This section describes the algorithm Remark uses to generate the resulting web-pages.
This step gathers a linear list of those files that are located in the input directory or its sub-directories. Files are identified with their location relative to the input directory (called a relative name). Only those files are accepted which have an associated document type or are explicitly specified at the invocation of Remark.
After the files have been gathered, their containing directories are gathered. If a directory is gathered, then so is its parent directory (unless the directory is the input directory). This set of directories is useful when one wants to generate a directory view.
Each document is parsed for tags by using its document-type. The purpose of this phase is to find out for a file its parent document, description, and a detailed description.
If a document specifies a parent document, then it is used to construct a part of the document tree. The parent is specified with a path which is given to the file-searching algorithm.
If a file does not have a parent document at this point, it is attempted to give an implicit parent.
If a document does not have parent document even after implicit linking, it is linked to a special orphan document. This guarantees that each document has a parent document. By generating a web-page that contains all the orphans, the user has a useful list of those document which are not linked to the documentation.
Using the list of involved directories, a directory.remark-index document is generated to each sub-directory of the document tree. In addition, an orphan.remark-orphan document is generated to the root directory of the document tree.
Each document in the document-tree is converted by its document-type.
At the end, Remark copies some files to the remark_files directory
of the output directory. These include Javascript files for mathematics
and image viewing, and CSS files for styling.