mirror of
https://github.com/aantron/better-enums.git
synced 2025-12-06 16:56:42 +08:00
Documentation can be generated by going to doc/ and running "make". This requires Python. Before this change, the user had to install the mistune library, which is used by the generator. The mistune library is now included in the Better Enums distribution. The generated docs are available at doc/html/index.html. Note that some links won't be local (the GitHub repo, the download link, outgoing links to MSDN, tutorial source in the GitHub repo, and so on). All the pages belonging to the actual docs will be local, however. The online version of the docs can be generated by running "make web". The only difference between the online and offline versions is that the former includes Google Analytics tracking code, and may include social communication buttons, comment section, or other useless things in the future. Also included errata since the last release. Resolves #2.
65 lines
1.4 KiB
Cheetah
65 lines
1.4 KiB
Cheetah
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
|
|
<title>$title</title>
|
|
|
|
<link rel="canonical" href="$canonical" />
|
|
<meta name="description" content="$description" />
|
|
<meta name="author" content="Anton Bachin" />
|
|
|
|
<meta name="viewport" content="width=device-width" />
|
|
|
|
<link rel="stylesheet" href="${prefix}better-enums.css" />
|
|
|
|
$ga
|
|
|
|
</head>
|
|
<body class="$class">
|
|
|
|
<nav>
|
|
<div class="container">
|
|
<a class="first" $download>Download</a>
|
|
<a href="$repo">GitHub</a>
|
|
<a href="${prefix}index.html">Home</a>
|
|
<a href="${prefix}tutorial/HelloWorld.html">Tutorial</a>
|
|
<a href="${prefix}ApiReference.html">Reference</a>
|
|
<a href="${prefix}Contact.html">Contact</a>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="spacer"> </div>
|
|
|
|
<header>
|
|
<div class="container">
|
|
<section>
|
|
<h1><a href="${prefix}index.html">Better Enums</a></h1>
|
|
<h2>Reflective compile-time enums for $cxx</h2>
|
|
<h3>Open-source under the BSD license</h3>
|
|
</section>
|
|
|
|
<section class="notes">
|
|
<p>Version $version</p>
|
|
<p>To install, just add <code>enum.h</code> to your project.</p>
|
|
<p>
|
|
Visit the GitHub repo for issues, feedback, and the latest development.
|
|
</p>
|
|
</section>
|
|
|
|
<section class="buttons">
|
|
<a $download>Download <code>enum.h</code></a>
|
|
<a href="$repo">GitHub</a>
|
|
</section>
|
|
</div>
|
|
</header>
|
|
|
|
<!-- <div class="buttons-bar">
|
|
<div class="container">
|
|
$twsupport
|
|
</div>
|
|
</div> -->
|
|
|
|
<div class="main">
|
|
<div class="container">
|