| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Documentation & Website | Apache Lucene.NET 4.8.0 </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Documentation & Website | Apache Lucene.NET 4.8.0 "> |
| <meta name="generator" content="docfx 2.46.0.0"> |
| |
| <link rel="shortcut icon" href="../logo/favicon.ico"> |
| <link rel="stylesheet" href="../styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="../styles/docfx.css"> |
| <link rel="stylesheet" href="../styles/main.css"> |
| <meta property="docfx:navrel" content="../toc.html"> |
| <meta property="docfx:tocrel" content="toc.html"> |
| |
| |
| |
| |
| <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:400,700%7CMerriweather%7CRoboto+Mono"> |
| <link rel="stylesheet" href="/styles/site.css"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="../index.html"> |
| <img id="logo" class="svg" src="../logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search" id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="contributing/documentation"> |
| <h1 id="documentation--website">Documentation & Website</h1> |
| |
| <hr> |
| <p><em>Details about this website and the API documentation site and how to help contribute to them</em></p> |
| <h2 id="overview">Overview</h2> |
| <p>The website and the api documentation source code is found in the same Git repository as the Lucene.Net code in the folder: <code>/websites/</code>. The site is built with a static site generator called <a href="https://dotnet.github.io/docfx/">DocFx</a> and all of the content/pages are created using Markdown files.</p> |
| <p>To submit changes for the website, create a Pull Request to the <a href="https://github.com/apache/lucenenet">Lucene Git repositoriy</a>. (See <a class="xref" href="index.html#submit-a-pull-request">Contributing</a> for details)</p> |
| <h2 id="website">Website</h2> |
| <p>To build the website and run it on your machine, run the powershell script: <code>/websites/site/site.ps1</code>. You don't have to pass any parameters in and it will build the site and host it at <a href="http://localhost:8080">http://localhost:8080</a>.</p> |
| <p>The script has 2 optional parameters:</p> |
| <ul> |
| <li><code>-ServeDocs</code> <em>(default is 1)</em> The value of <code>1</code> means it will build the docs and host the site, if <code>0</code> is specified, it will build the static site to be hosted elsewhere.</li> |
| <li><code>-Clean</code> <em>(default is 0)</em> The value of <code>1</code> means that it will clear all caches and tool files before it builds again. This is handy if a new version of docfx is available or if there's odd things occuring with the incremental build.</li> |
| </ul> |
| <p>The file/folder structure is within <code>/websites/site</code>:</p> |
| <ul> |
| <li><code>site.ps1</code> - the build script</li> |
| <li><code>docfx.json</code> - the DocFx configuration file <em>(see docfx manual for further info)</em></li> |
| <li><code>lucenetemplate/*</code> - the custom template files to style the website</li> |
| <li><code>*.md</code> - the root site content such as the index and download pages</li> |
| <li><code>toc.yml</code> - these files determine the menu structures <em>(see docfx manual for further info)</em></li> |
| <li><code>contributing/*</code> - the Contributing section</li> |
| <li><code>tools/*</code> - during the build process some tools will be downloaded which are stored here</li> |
| <li><code>_site</code> - this is the exported static site that is generated</li> |
| </ul> |
| <h2 id="api-docs">API Docs</h2> |
| <p>To build the api docs and run it on your machine, run the powershell script: <code>/websites/apidocs/docs.ps1</code>. You don't have to pass any parameters in and it will build the site and host it at <a href="http://localhost:8080">http://localhost:8080</a>.</p> |
| <p>The script has 2 optional parameters:</p> |
| <ul> |
| <li><code>-ServeDocs</code> <em>(default is 1)</em> The value of <code>1</code> means it will build the docs and host the site, if <code>0</code> is specified, it will build the static site to be hosted elsewhere.</li> |
| <li><code>-Clean</code> <em>(default is 0)</em> The value of <code>1</code> means that it will clear all caches and tool files before it builds again. This is handy if a new version of docfx is available or if there's odd things occuring with the incremental build.</li> |
| </ul> |
| <p>The file/folder structure is within <code>/websites/apidocs</code>:</p> |
| <ul> |
| <li><code>docs.ps1</code> - the build script</li> |
| <li><code>docfx.json</code> - the DocFx configuration file <em>(see docfx manual for further info)</em></li> |
| <li><code>lucenetemplate/*</code> - the custom template files to style the website</li> |
| <li><code>*.md</code> - the root site content such as the index and download pages</li> |
| <li><code>toc.yml</code> - these files determine the menu structures <em>(see docfx manual for further info)</em></li> |
| <li><code>tools/*</code> - during the build process some tools will be downloaded which are stored here</li> |
| <li><code>_site</code> - this is the exported static site that is generated</li> |
| </ul> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/master/websites/site/contributing/documentation.md/#L1" class="contribution-link">Improve this Doc</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2019 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="../styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="../styles/docfx.js"></script> |
| <script type="text/javascript" src="../styles/main.js"></script> |
| </body> |
| </html> |
