Skip to content

Commit

Permalink
Rest api - add samples for tags and overwrite doc (docascode#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
hellosnow authored and superyyrrzz committed Jun 2, 2016
1 parent e7fecf9 commit 10e303a
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 6 deletions.
2 changes: 1 addition & 1 deletion articles/docfx_getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Getting Started

This is a seed. ![Seed](images/seed.jpg)

`docfx` is an API documentation generator for .NET, currently support C# and VB. It has the ability to extract triple slash comments out from your source code. What's more, it has syntax to link additional files to API to add additional remarks. `docfx` will scan your source code and your additional conceptual files and generate a complete HTML documentation website for you. `docfx` provides the flexibility for you to customize the website through templates. We currently have several embeded templates, including websites containing pure static html pages and also website managed by AngularJS.
`docfx` is an API documentation generator for .NET, currently support C# and VB. It has the ability to extract triple slash comments out from your source code. What's more, it has syntax to link additional files to API to add additional remarks. `docfx` will scan your source code and your additional conceptual files and generate a complete HTML documentation website for you. `docfx` provides the flexibility for you to customize the website through templates. We currently have several embedded templates, including websites containing pure static html pages and also website managed by AngularJS.

* Click "View Source" for an API to route to the source code in GitHub (your API must be pushed to GitHub)
* `docfx` provide DNX version for cross platform use.
Expand Down
8 changes: 5 additions & 3 deletions restapi/petstore.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,8 @@
],
"summary": "Add a new pet to the store",
"tags": [
"pet"
"pet",
"store"
]
},
"put": {
Expand Down Expand Up @@ -985,7 +986,7 @@
},
"summary": "Updated user",
"tags": [
"user"
"unknown"
]
}
}
Expand All @@ -1012,7 +1013,8 @@
"swagger": "2.0",
"tags": [
{
"description": "Everything about your Pets",
"description": "Everything about your **Pets**",
"x-bookmark-id": "EverythingAboutYourPets",
"externalDocs": {
"description": "Find out more",
"url": "http://swagger.io"
Expand Down
4 changes: 2 additions & 2 deletions specs/Cat.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
uid: CatLibrary.Cat`2
remarks: '*THIS* is remarks overriden in *MARKDWON* file'
remarks: '*THIS* is remarks overridden in *MARKDWON* file'
---

This is a class talking about [CAT](https://en.wikipedia.org/wiki/Cat).
Expand All @@ -13,7 +13,7 @@ Refer to @CatLibrary.IAnimal to see other animals.

---
uid: CatLibrary.IAnimal
remarks: '*THIS* is remarks overriden in *MARKDWON* file'
remarks: '*THIS* is remarks overridden in *MARKDWON* file'
---

### Welcome to the **Animal** world!
Expand Down
13 changes: 13 additions & 0 deletions specs/petstore-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,16 @@ uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/addPet
footer: *content
---
> NOTE: Add pet only when you needs.
---
uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/tag/pet
description: *content
---

Description for pet tag

---
uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/tag/store
---

Additional description for store tag

0 comments on commit 10e303a

Please sign in to comment.