15 |
16 |
--------------------------------------------------------------------------------
/samples/seed/pdf/toc.yml:
--------------------------------------------------------------------------------
1 | order: 200
2 | items:
3 | - name: Articles
4 | href: ../articles/toc.yml
5 | - name: API Documentation
6 | href: ../obj/api/toc.yml
7 | - name: REST API
8 | href: ../restapi/toc.md
9 |
--------------------------------------------------------------------------------
/samples/seed/restapi/toc.md:
--------------------------------------------------------------------------------
1 | # [Pet Store API](petstore.swagger.json)
2 | # [Contacts API](contacts_swagger2.json)
3 |
--------------------------------------------------------------------------------
/samples/seed/specs/Cat.md:
--------------------------------------------------------------------------------
1 | ---
2 | uid: CatLibrary.Cat`2
3 | remarks: '*THIS* is remarks overridden in *MARKDWON* file'
4 | ---
5 |
6 | This is a class talking about [CAT](https://en.wikipedia.org/wiki/Cat).
7 |
8 | >**NOTE**
9 | > This is a CAT class
10 | >
11 |
12 | Refer to @CatLibrary.IAnimal to see other animals.
13 |
--------------------------------------------------------------------------------
/samples/seed/specs/CatLibrary.IAnimal.md:
--------------------------------------------------------------------------------
1 | ---
2 | uid: CatLibrary.IAnimal
3 | remarks: '*THIS* is remarks overridden in *MARKDWON* file'
4 | ---
5 |
6 | ### Welcome to the **Animal** world!
7 |
--------------------------------------------------------------------------------
/samples/seed/specs/petstore-operations.addPet.footer.md:
--------------------------------------------------------------------------------
1 | ---
2 | uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/addPet
3 | footer: *content
4 | ---
5 | > NOTE: Add pet only when you needs.
6 |
--------------------------------------------------------------------------------
/samples/seed/specs/petstore-operations.footer.md:
--------------------------------------------------------------------------------
1 | ---
2 | uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0
3 | title: Pet Store APIs
4 | footer: *content
5 | ---
6 |
7 | ### See Alsos
8 |
9 | See other REST APIs:
10 | * [Contacts API](../restapi/contacts_swagger2.json)
11 |
12 |
--------------------------------------------------------------------------------
/samples/seed/specs/petstore-operations.md:
--------------------------------------------------------------------------------
1 | ---
2 | uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0
3 | title: Pet Store APIs
4 | ---
5 |
6 | Describe APIs in Pet Store
7 |
--------------------------------------------------------------------------------
/samples/seed/specs/petstore-operations.tag.pet.md:
--------------------------------------------------------------------------------
1 | ---
2 | uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/tag/pet
3 | description: *content
4 | ---
5 |
6 | Description for pet tag
--------------------------------------------------------------------------------
/samples/seed/specs/petstore-operations.tag.store.md:
--------------------------------------------------------------------------------
1 | ---
2 | uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/tag/store
3 | ---
4 |
5 | Additional description for store tag
--------------------------------------------------------------------------------
/samples/seed/template/public/main.js:
--------------------------------------------------------------------------------
1 | import { bicep } from './bicep.js'
2 |
3 | export default {
4 | iconLinks: [
5 | {
6 | icon: 'github',
7 | href: 'https://github.com/dotnet/docfx',
8 | title: 'GitHub'
9 | },
10 | {
11 | icon: 'twitter',
12 | href: 'https://twitter.com/',
13 | title: 'Twitter'
14 | }
15 | ],
16 | lunrLanguages: ['en', 'ru'],
17 | start() {
18 | console.log('started');
19 | },
20 | configureHljs (hljs) {
21 | hljs.registerLanguage('bicep', bicep);
22 | },
23 | }
24 |
25 |
--------------------------------------------------------------------------------
/samples/seed/template/token.json:
--------------------------------------------------------------------------------
1 | {
2 | "todo": "MY TODO"
3 | }
--------------------------------------------------------------------------------
/samples/seed/toc.yml:
--------------------------------------------------------------------------------
1 | - name: Home
2 | href: index.md
3 | - name: Articles
4 | href: articles/
5 | - name: API Documentation
6 | items:
7 | - name: .NET API
8 | href: obj/api/
9 | - name: .NET API (markdown)
10 | href: obj/md/
11 | - name: .NET API (apipage)
12 | href: obj/apipage/
13 | - name: REST API
14 | href: restapi/
15 |
--------------------------------------------------------------------------------
/src/Directory.Build.props:
--------------------------------------------------------------------------------
1 | DOCFX PDF SAMPLE
17 |
5 |
6 |
--------------------------------------------------------------------------------
/templates/default/partials/namespace.tmpl.partial:
--------------------------------------------------------------------------------
1 | {{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2 |
3 | {{>partials/title}}
4 |{{{summary}}}
5 | {{{conceptual}}}
6 | {{{remarks}}}
7 | {{#children}}
8 | {{>partials/namespaceSubtitle}}
9 | {{#children}} 10 |
4 |
10 |
--------------------------------------------------------------------------------
/templates/default/partials/toc.tmpl.partial:
--------------------------------------------------------------------------------
1 | {{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2 |
3 |
9 |
--------------------------------------------------------------------------------
/templates/default/partials/uref/inheritance.tmpl.partial:
--------------------------------------------------------------------------------
1 | {{#inheritance}}
2 | {{>partials/uref/inheritance}}
3 | {{/inheritance}}
4 | {{__global.searchResults}}
5 |
6 |
8 | 7 |
{{{type.specName.0.value}}}
5 |
--------------------------------------------------------------------------------
/templates/default/src/docfx.vendor.js:
--------------------------------------------------------------------------------
1 | // Licensed to the .NET Foundation under one or more agreements.
2 | // The .NET Foundation licenses this file to you under the MIT license.
3 |
4 | require('@default/bootstrap/dist/css/bootstrap.css')
5 | require('@default/highlight.js/styles/github.css')
6 |
7 | window.$ = window.jQuery = require('jquery')
8 |
9 | require('@default/bootstrap')
10 | require('@default/twbs-pagination')
11 | require('@default/mark.js/src/jquery')
12 |
13 | const AnchorJS = require('@default/anchor-js')
14 | window.anchors = new AnchorJS()
15 |
16 | window.hljs = require('@default/highlight.js')
17 | require('@default/url/src/url.js')
18 |
--------------------------------------------------------------------------------
/templates/default/styles/main.css:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dotnet/docfx/db31f42a632c1bfe2d71e7c2c1201c845c3c8ea7/templates/default/styles/main.css
--------------------------------------------------------------------------------
/templates/default/styles/main.js:
--------------------------------------------------------------------------------
1 | // Licensed to the .NET Foundation under one or more agreements.
2 | // The .NET Foundation licenses this file to you under the MIT license.
3 |
--------------------------------------------------------------------------------
/templates/default/toc.extension.js:
--------------------------------------------------------------------------------
1 | // Licensed to the .NET Foundation under one or more agreements.
2 | // The .NET Foundation licenses this file to you under the MIT license.
3 |
4 | /**
5 | * This method will be called at the start of exports.transform in toc.html.js and toc.json.js
6 | */
7 | exports.preTransform = function (model) {
8 | return model;
9 | }
10 |
11 | /**
12 | * This method will be called at the end of exports.transform in toc.html.js and toc.json.js
13 | */
14 | exports.postTransform = function (model) {
15 | return model;
16 | }
17 |
--------------------------------------------------------------------------------
/templates/default/toc.json.tmpl:
--------------------------------------------------------------------------------
1 | {{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2 |
3 | {{{content}}}
4 |
--------------------------------------------------------------------------------
/templates/modern/ApiPage.html.primary.js:
--------------------------------------------------------------------------------
1 | // Licensed to the .NET Foundation under one or more agreements.
2 | // The .NET Foundation licenses this file to you under the MIT license.
3 |
4 | exports.transform = function (model) {
5 | return model;
6 | }
7 |
--------------------------------------------------------------------------------
/templates/modern/ApiPage.html.primary.tmpl:
--------------------------------------------------------------------------------
1 | {{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2 | {{!master(layout/_master.tmpl)}}
3 |
4 | {{{content}}}
5 |
--------------------------------------------------------------------------------
/templates/modern/partials/collection.tmpl.partial:
--------------------------------------------------------------------------------
1 | {{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2 |
3 | {{>partials/class}}
4 |
--------------------------------------------------------------------------------
/templates/modern/partials/customMREFContent.tmpl.partial:
--------------------------------------------------------------------------------
1 | {{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2 | {{!Add your own custom template for the content for ManagedReference here}}
3 | {{#_splitReference}}
4 | {{#isCollection}}
5 | {{>partials/collection}}
6 | {{/isCollection}}
7 | {{#isItem}}
8 | {{>partials/item}}
9 | {{/isItem}}
10 | {{/_splitReference}}
11 |
--------------------------------------------------------------------------------
/templates/modern/partials/enum.tmpl.partial:
--------------------------------------------------------------------------------
1 | {{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2 |
3 | {{>partials/class.header}}
4 |
5 | {{#seealso.0}}
6 | {{__global.seealso}}
7 |
8 | {{/seealso.0}}
9 | {{#seealso}}
10 | {{#isCref}}
11 |
19 | {{/seealso.0}}
20 |
--------------------------------------------------------------------------------
/templates/modern/partials/item.tmpl.partial:
--------------------------------------------------------------------------------
1 | {{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2 |
3 | {{>partials/class.header}}
4 |
--------------------------------------------------------------------------------
/templates/modern/partials/namespace.tmpl.partial:
--------------------------------------------------------------------------------
1 | {{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2 |
3 | {{{type.specName.0.value}}}
12 | {{/isCref}}
13 | {{^isCref}}
14 | {{{url}}}
15 | {{/isCref}}
16 | {{/seealso}}
17 | {{#seealso.0}}
18 | {{>partials/title}}
4 |{{{summary}}}
5 | {{{conceptual}}}
6 | {{{remarks}}}
7 |
8 | {{#children}}
9 | {{>partials/namespaceSubtitle}}
10 | {{#children}} 11 |-
12 |
- {{{summary}}} 14 |
T.
15 |
16 | ```csharp
17 | void DoNothing