This commit is contained in:
Wiesław Šoltés 2016-08-31 23:29:20 +02:00
Родитель 0807e4acf9
Коммит 70db5beea9
8 изменённых файлов: 84 добавлений и 0 удалений

3
docs/.gitignore поставляемый Normal file
Просмотреть файл

@ -0,0 +1,3 @@
#docfx
_site
api

21
docs/README.md Normal file
Просмотреть файл

@ -0,0 +1,21 @@
# ReactiveHistory Documentation
* [API Reference](http://wieslawsoltes.github.io/ReactiveHistory/)
## Building
Download and unzip `docfx.zip` into `Documentation` folder from [DocFX project site](https://github.com/dotnet/docfx/releases).
**Step 1.** To create `_site` documentation folder run build script
```
build.cmd
```
**Step 2.** To browse `_site` documentation folder run serve script
```
serve.cmd
```
And you can view the generated website in your browser `http://localhost:8080`.

3
docs/build.cmd Normal file
Просмотреть файл

@ -0,0 +1,3 @@
@echo off
docfx metadata
docfx build

35
docs/docfx.json Normal file
Просмотреть файл

@ -0,0 +1,35 @@
{
"metadata": [
{
"src": [
{
"files": [
"/src/ReactiveHistory/ReactiveHistory.csproj"
],
"exclude": [ "**/bin/**", "**/obj/**" ],
"cwd": ".."
}
],
"dest": "api"
},
],
"build": {
"content":
[
{
"files": ["**/*.yml", "index.md", "tutorial/*.md"],
}
],
"resource": [
{
"files": ["images/**"]
}
],
"overwrite": "apidoc/*.md",
"globalMetadata": {
"_appTitle": "ReactiveHistory Website"
},
"dest": "_site",
"template": [ "default", "template"]
}
}

3
docs/index.md Normal file
Просмотреть файл

@ -0,0 +1,3 @@
# ReactiveHistory Documentation Site
Welcome to the ReactiveHistory documentation site.

2
docs/serve.cmd Normal file
Просмотреть файл

@ -0,0 +1,2 @@
@echo off
docfx serve _site

13
docs/template/partials/footer.tmpl.partial поставляемый Normal file
Просмотреть файл

@ -0,0 +1,13 @@
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2016 Wiesław Šoltés<br>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>

4
docs/toc.yml Normal file
Просмотреть файл

@ -0,0 +1,4 @@
- name: Home
href: index.md
- name: API Reference
href: api/